Chapter 15: Documenting Code
No matter how well implemented a shard is, if the user does not know how to use it, then they will not be able to make full use of it or will give up entirely. Having well-documented code can be just as important as having well-written or well-tested code. As suggested by https://documentation.divio.com, proper documentation for a software product should cover four separate areas:
- Tutorials
- How-to guides
- Explanations
- References
Each of these areas lets you consume the documentation, depending on what you want to do – for example, wanting to solve a specific problem versus figuring out the parameters to a specific method. While the first three are best handled via code, Crystal comes with some easy-to-use code documentation features that can make creating reference documentation pretty painless.
In this chapter, we are going to cover the following topics:
- Documenting Crystal code
- Documentation directives ...