PEAR 程式撰寫標準-註解

原始出處 http://www.xoops.org/modules/mediawiki/index.php/Dev:coding_standards

類別的內插文件應該要遵守PHPDoc 規則，此規則相似於Javadoc。更多PHPDoc 的資料可以在這裡找到：http://www.phpdoc.org/

也可以在這個Wiki 找到：XoopsAndPhpDocumentor Adding PHPDocumentor comments

也很鼓勵非文件的註解。有一個規定是如果你看著一段程式碼並覺得哇我不想先跑一次然後解釋這段程式碼的話，你就需要在忘了這段程式碼在作什麼之前就對這段程式碼作註解。

C 語言的註解（/* */）與標準C++ 語言的註解（//）都可以。不建議使用Perl/shell 語言的註解（#）。