search

nicoespeon / trello-kanban-analysis-tool

💤 [Not maintained] Analyse Kanban metrics from a Trello board -
http://nicoespeon.com/trello-kanban-analysis-tool/
MIT License
114 stars 33 forks source link

Add code documentation #10

Closed nicoespeon closed 8 years ago

nicoespeon commented 8 years ago

Check https://esdoc.org/

nicoespeon commented 8 years ago

After trying to implement ESDoc I'm not sure this is a great idea.

Actually, the FP-style of this project ends with a lot of const that are methods composed from others. Hence, they are documented as variables instead of functions, which is odd from a doc point of view.

I think the issue is mainly because JSDoc / ESDoc is designed for an Object-Oriented style of programmation.

Hence, I'll stick with FP-like function signatures + comments when necessary to explain code.

Feel free to challenge this point of view and to propose suggestions − I may have missed something.