最新消息:欢迎加入小松的QQ群一起讨论一起学习,搜索页面修改成lua+ElasticSearch,使用php这个页面速度相对慢一点,优化之后速度杠杠的,如有问题请加群联系我

php代码注释

PHP 762浏览 0评论

php代码注释

代码注释在多人开发的时候非常重要,现象一下,一段代码没有任何主要你去结合运行的效果去看实现的逻辑,那是非常费劲的事。
如果让别人看懂你写的代码,代码注释启动非常重要的作用。一个不会写代码注释的不是一个好的程序员

1、文件头部注释

/**
*这是一个什么文件
*
*此文件程序用来做什么的(详细说明,可选。)。
* @author phpsong
* @version 1.0
*/

2、函数头部注释

/**
* 函数的含义说明
* @author phpsong
* @param mixed $arg1 参数一的说明
* @param mixed $arg2 参数二的说明
* @param mixed $mixed 这是一个混合类型
* @return array
*/
public function testFunction($string, $integer, $mixed) {return array();}

3、类的注释

/**
* 类的介绍
*
* 类的详细介绍(可选。)。
* @author phpsong
*/
class Test
{
}

4、单独行注释

$this->createDataFiles(); // 生成数据文件

5、代码片段注释,上下行用空出一行

/*下面载入配置*/
$this->setConfig();
$this->createConfigFile();

这是我结合自己实际情况写的代码注释,有问题请留言

QQ交流群:136351212(满) 455721967

如无特别说明,本站文章皆为原创,若要转载,务必请注明以下原文信息:
转载保留版权:小松博客» php代码注释
本文链接地址:https://www.phpsong.com/1043.html

发表我的评论
取消评论
表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
木有头像就木有JJ!点这里按步骤申请Gravatar头像吧!

网友最新评论 (1)

加载中,请稍候...
  1. 哈哈,这个好
    手机回收2015-08-05 18:26:24回复