技术文档可以使人们更好得使用他人的代码库,然而,作为开发人员,编写文档确是一件让人头疼的事情。PHPDoc是PHP文档注释的一个标准,它可以实现为代码生成API文档。
PHPDoc注释规范:
块注释的开始及结束标志分别为"/**" 、"*/" ,它的后面必需紧跟着被注释的函数,如下所示:
1 /** 2 * 块注释 3 */ 4 public foo() 5 { 6 }
块注释中可以包含标签:
此外,在phpstorm中,可以通过:
1、Code->Generate->PHPDoc Blocks… 自动生成phpDoc的注释
2、File->Settings->File and Code Templates 修改注释模板
参考资料:
2、http://www.cnblogs.com/picaso/archive/2012/10/04/2711435.html
3、http://en.wikipedia.org/wiki/Phpdoc
时间: 2024-08-05 08:30:15