##compiler-enforced documentation techniques #xLang

I’m a big fan of non-comment source documentation such as

1. assert
2. C++ enum
3. typedef — “typedef int FibNum” as source documentation
4. java annotations
5. final/override (c++11), sealed, and const keywords

Advertisements