php – 美丽的代码评论块设计：画廊,文章,偏好

发布时间：2020-12-13 16:32:49 所属栏目：PHP教程来源：网络整理

导读：我总是大量记录我的代码,以便其他人(和我自己在路上)可以快速了解发生了什么.所以我经常想知道是否有任何画廊或评论设计的集合.任何链接或只是普通偏好？这是我经常使用的一个(在PHP中). 在文件的顶部： // ******************************* INFORMATION **

我总是大量记录我的代码,以便其他人(和我自己在路上)可以快速了解发生了什么.所以我经常想知道是否有任何画廊或评论设计的集合.任何链接或只是普通偏好？

这是我经常使用的一个(在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文件.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!