phpdoc注释规范 - 介绍一个类 ¶

在class关键字上面开始添加以下注释块,第一行是 /* 第二行空一格后对住上一行的第一个继续打一个,第三行结束的时候则是空格/ ,然后第二行写一段文本介绍这个类

/**
 * MySql数据库操作类
 * @author 张三
 */
class MySql{

}

注意必须要 /* 开头而不能 / ,否则无法生成到文档说明中!

@author这里是声明类的作者，当然也要空一个空格才能写作者名字

浏览效果:

另外备注内容支持markdown，比如这样：

/**
 * XXX类，这是一个**核心**类
 */

想让备注内容排版漂亮点/高级排版可以使用Markdown文本规范书写，只是用apigen生成的并不是太好看，到时候用别的工具就好了嘛