|
|
|
|
|
by solidasparagus
2250 days ago
|
|
There is very much a need for documentation. I keep hearing "auto-generated" documentation, but I don't see what differentiates this from other tools that generate docs from code comments. Without more detailed information about what this tool does, there is no reason to pursue it further. There are myriad questions that need answering with docs: - What does autogenerating documentation mean? (in my book, exposing code comments is not autogeneration so hopefully there is more) - When I edit function documentation does it also change the code comments? Vice versa? - How is the documentation version controlled? - How are multiple versions of a library documented? - What level of customization do I get? Just look at the Sphinx ecosystem for all of the things that people end up needing to customize. - The chore part of documentation is thinking about what to write and writing it so that it is easy to understand - does this actually help me here? |
|