Use Automatic Checks Where Possible [DM5]
Tip DM5
Compilers can’t typically check comments, and fully checking the content of comments for accuracy or missing information isn’t something current tools can do automatically. However, many documentation generator tools can at least spit out warnings that can alert to symbols with missing documentation or mismatches in parameters.
Below are examples of warnings from various documentation generators that hint at outdated documentation:
