php代码注释处理类库,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

查看原文：http://www.phpsong.com/1043.html

php代码注释处理类库,php代码注释相关推荐

yolov3网络结构图_目标检测——YOLO V3简介及代码注释（附github代码——已跑通）...
GitHub: liuyuemaicha/PyTorch-YOLOv3github.com 注:该代码fork自eriklindernoren/PyTorch-YOLOv3,该代码相比master分 ...
c++ doxygen 注释规范_C语言代码注释参考
简述该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定. Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX.RTF参考手册.简单 ...
Xcode12.5的自定义代码块的使用和函数注释(学会事半功倍)
Xcode12.5的自定义代码块的使用和函数注释(学会事半功倍) 第一篇快捷键的定义 @property (nonatomic , strong) <#type#> <#name# ...
php代码清除空格注解,去除php注释和去除空格函数分享
虽然php5中已有php_strip_whitespace方法可以返回删除注释和空格后的PHP源码的功能,为了学习,这里为大家提供一个自己的方法,也可以去除代码中的空白和注释,代码如下: . 代码如下 ...
python输出箭头代码_python matplotlib 注释文本箭头简单代码示例
注释文本箭头结果展示: 完整代码示例: import numpy as np import matplotlib.pyplot as plt fig,ax = plt.subplots(figsiz ...
超有意思的代码注释_程序员搞笑的代码注释：谁的代码注释我都不服，就服你的...
什么是代码注释,如何在代码中添加注释,相信每一位了解编程的人并不陌生.注释里往往有很多有趣的脑洞和「真心话」.今天我们一起去看看那些6到飞起,被玩坏了的幽默注释吧. 信息量太大的注释系列-- 01 你 ...
如何在Python中注释掉一段代码[重复]
本文翻译自:How to comment out a block of code in Python [duplicate] This question already has an answer h ...
开发规范-java代码注释及IDEA配置代码注释模板
引(阿里巴巴开发规范-注释规约) [强制]类.类属性.类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用 // xxx 方式. 说明:在 IDE 编辑窗口中,Javadoc 方式 ...
BP神经网络预测回归MATLAB代码（代码完整可直接用，注释详细，可供学习）
BP神经网络预测回归MATLAB代码(代码完整可直接用,注释详细,可供学习) 一.前言二.代码部分 2.1 初始化 2.2 读取数据 2.3 设置训练集和测试集 2.4 数据归一化 2.5 求解最佳 ...

php代码注释处理类库,php代码注释

php代码注释处理类库,php代码注释相关推荐

最新文章

热门文章