Monday, March 16, 2009

How to use comments in programming?

(http://antbsd.twbbs.org/~ant/wordpress/?p=495, December 1st, 2006)

最近讀了 Tor Norbye 的文章,Code Advice #2: No Vanity Tokens

作者認為很多程式設計師常下沒有意義的 comments,這些 comments 並沒有讓程式碼更容易閱讀。並且建議,這些描述程式碼的 comments 或是誰寫了這些程式,都應該用 version control system 來控制。

也提到他的 comments 的用法以及標準。標準的 comments,含 TODO、FIXME 和 XXX。TODO應該大部分人都知道,定義比較模糊的是 FIXME 和 XXX。作者提到在 SUN Java 的文件中,有對兩者的一番解釋

Use XXX in a comment to flag something that is bogus but works. Use FIXME to flag something that is bogus and broken.

最後作者也提出其它他常用的 comments,例如 JDK15 及 NOI18N。

No comments:

Post a Comment