Following documentation guidelines
Documentation is an integral part of software development because it’s how teams communicate with each other on how to work on a code base. It’s also how users of the software learn how to be productive with it. Documentation should never be an overlooked practice within software development because the code cannot speak for itself. Documentation keeps the code maintainable and provides a manual of its usage.
One of the most common ways that developers create code documentation is through comments, where they can leave notes about the functionality in small lines. You have seen comments in many examples, where a comment starts with the // syntax, is only used to document the code, and is not executed in any way. The main guidelines are these:
- Comments should be on their own separate line and not at the end of any line of code
- Each comment should be a complete sentence, where it starts with an uppercase character and ends...
