我总是大量记录我的代码,以便其他人(和我自己在路上)可以快速了解发生了什么.所以我经常想知道是否有任何画廊或评论设计的集合.任何链接或只是普通偏好？
这是我经常使用的一个(在PHP中).
在文件的顶部：
// ******************************* INFORMATION ***************************// // ***********************************************************************// // // ** NAME - A description of what the file does. // ** // ** @author name <name@name.com> // ** @date date // ** @access private // ** @param // ** @return if a class what object is returned // // ***********************************************************************// // ********************************** START ******************************//
用于标注一组功能：
// =======================================================================// // ! A description of what the following functions have in common // // =======================================================================//
虽然这是主观的,如@jcomeau_ictx所建议的,但是像PHPDocumentor(或PHPdoc或PHPdocu)这样的东西.我强烈建议你看看它.您可以在
http://manual.phpdoc.org/HTMLframesConverter/default/找到文档.
他们的语法与你的语法略有不同.它类似于Javadoc.
例如：
/** * Sample File 3,PHPDocumentor Quickstart * * This file demonstrates the use of the @name tag * @author Greg Beaver <cellog@PHP.net> * @version 1.0 * @package sample */
有一些你可以在网站上看到的例子.
如果您想查看其他开发人员在做什么,还可以查看http://www.google.com/codesearch并搜索包含更有可能发表评论的某些单词(如函数或类)的PHP文件.
