##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

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s