Next: , Previous: , Up: Tips and Conventions   [Contents][Index]

D.6 Tips for Documentation Strings

Here are some tips and conventions for the writing of documentation strings. You can check many of these conventions by running the command M-x checkdoc-minor-mode.



We do use these occasionally, but try not to overdo it.

Next: Tips on Writing Comments, Previous: Tips for Avoiding Compiler Warnings, Up: Tips and Conventions   [Contents][Index]