Recap
The current Fusion Reference is built using hardcoded templates. The goal of this proposal is to move the documentation into the code to generate the Fusion Reference straight from the code and to improve the Developer Experience (IDE support etc.).
Options
We are currently at the point where there are two main choices for how fusion can be documented. Either using some kind of properties (1.) for the “fusion-way” or using some kind of comments (2.), as other programming languages do.
Syntax highlighting for better readability and adaption will be provided either way.
The styles of comments, syntax within these comments, and the specific meta properties to be used are not part of this poll.
The same goes for type hints; how and whether we want to incorporate type hints and to what extent should also not influence the decisions.
1. @doc
Documenting prototypes and properties using some kind of @doc meta tags.
For example:
2. ///
Documenting prototypes using some kind of multiline “comments” (e.g. /** **/) and properties with single line “comments” (e.g. ///)
For example:
Poll
How should we document fusion?
- 1:
@doc- Metaproperties - 2:
///- Comments