Hey folks! I want to add documentation for individual fields on a struct/typedstruct, and I’m wondering about available options? I’m new in elixir. typedstruct do @typedoc "Foo struct is so foo" # the foo field is so foo field :foo, String.t() # the bar field is so bar field :bar, Strin…

Assuming that you’re creating documentation with ExDoc vs. trying to create simple code comments that describe the field I’ll document the individual fields directly in the struct’s @typedoc. So your: [image] ddoronin: @typedoc "Foo struct is so foo" becomes something like: @typedoc """ F…

The convention is to create a type called t using the @type attribute. defmodule MyApp.Foo do defstruct [:foo, :bar] @typedoc "My Foo data type." @type t :: %__MODULE__{foo: String.t(), bar: String.t()} @spec new_foo(keyword) :: t def new_foo(opts) do struct!(__MODULE__, opts) …

typedstruct will generate the t() under the hood. My question was more about individual fields on a struct. Those are :foo and :bar in my example: # the foo field is so foo field :foo, String.t() # the bar field is so bar field :bar, String.t() What you are suggesting is something like th…

Sorry I guess I misunderstood your question! I’m not familiar with that library, I thought it was pseudocode :slight_smile: IMO, t() is self-documenting as far as what types you expect in the fields. If I wanted more documentation I would add it to the top-level @typedoc. e.g. @typedoc """ The Foo…

I should note that this assumes this is for public functions/modules. When the code being documented is private, I’ll just use normal code comments to include any helpful documentation with the understanding that won’t render in ExDoc’s output.

[image] ddoronin: What you are suggesting is something like this: @typedoc "the foo field is so foo" @type foo::String @typedoc "the bar field is so bar" @type bar::String typedstruct do @typedoc "Foo struct is so foo" field :foo, foo field :bar, bar end btw, this was not what I was…

yep, this is for public modules, and I’m using ExDoc.

@msimonborg Gotcha! It was probably mixed up in my head with another answer given by thelastinuit . It seems like @typedoc with the “Fields” section is the most common way to document struct fields.

No worries :slight_smile: It’s also the same documentation approach for function options and the like @doc """ Make a new Foo. ## Options * `:foo` - A string that is so foo. * `:bar` - A string that is so bar. """ @spec new_foo(options :: keyword) :: t def new_foo(options), do: struct!(__MOD…

Elixir Programming Language Forum

How to document fields on a struct?

Questions & Help Questions

thelastinuit June 29, 2022, 9:44pm 2

You can create custom typespec and document with this