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

发布时间:2022-04-30 发布网站:脚本宝典
脚本宝典收集整理的这篇文章主要介绍了php – 美丽的代码评论块设计:画廊,文章,偏好脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
我总是大量记录我的代码,以便其他人(和我自己在路上)可以快速了解发生了什么.所以我经常想知道是否有任何画廊或评论设计的集合.任何链接或只是普通偏好?

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

脚本宝典总结

以上是脚本宝典为你收集整理的php – 美丽的代码评论块设计:画廊,文章,偏好全部内容,希望文章能够帮你解决php – 美丽的代码评论块设计:画廊,文章,偏好所遇到的问题。

如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典推荐好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。