I'm currently working on a massive project with many interconnected models. I want to create documentation to minimize code duplication and ensure that every developer can easily understand and follow the code. Is documenting the code a good idea? If so, how do you suggest I go about creating that documentation?
1 Answer
The documentation process really depends on the programming language you're using. For instance, in Python, Sphinx is a great tool to generate documentation. All functions should have a brief comment on what they do, but especially highlight the parts that aren't obvious. For example, if you’re using a complex function or engaging in some clever coding tricks, be sure to explain those thoroughly.
I’m using PHP with Laravel. I know how to comment in code, but I worry about other developers not knowing about certain helper functions I've created. How can I ensure they find them so they're not duplicating my work?