Summary

And there you have it! Everything you need to know about how to best document your code. The typed nature of Crystal helps remove some of the burdens of writing documentation as it will handle the basics. Using a flavor of markdown for code comments also helps by keeping the documentation close to the code, reducing the likelihood that it becomes outdated.

Now that we know how to write a well-designed, tested, and documented application, it is time to move on to the final step: deploying it! In the next chapter, we are going to learn how shards should be versioned, how to create a production binary, and how to distribute it using Docker.