- Joined
- Jul 31, 2017
- Messages
- 500
The Modules section in the docs explain how they work. But it doesn't very well cover the topic how a good module is documented. I mean, I could look how it's done with other modules. That way I would probably only learn about how a module works fine even if the code to comments ratio is approx ERROR_DIVISION_BY_ZERO
But I'm interested in more:
- Naming conventions (I found capitalisation rules). Like prefixing class names or private fields.
- Conventions for function descriptions / headers (comments).
- How to do a good documentation of your module. Preferably coming with a documentation of .cerberusdoc-file syntax.
TBH I might end up ignoring some of the "rules". I'm fine with stuff like guidelines or even simple examples of beautiful code and docs rather than ultra strict industry-proof standards. It's just to be sure not to completely mess up when moduling And my first concern is documentation.
Even Aristoteles knew:
The code is more than the sum of its keywords.
But I'm interested in more:
- Naming conventions (I found capitalisation rules). Like prefixing class names or private fields.
- Conventions for function descriptions / headers (comments).
- How to do a good documentation of your module. Preferably coming with a documentation of .cerberusdoc-file syntax.
TBH I might end up ignoring some of the "rules". I'm fine with stuff like guidelines or even simple examples of beautiful code and docs rather than ultra strict industry-proof standards. It's just to be sure not to completely mess up when moduling And my first concern is documentation.
Even Aristoteles knew:
The code is more than the sum of its keywords.