我喜欢给自己的代码写尽可能多的注释和docblock,做过的公司和项目,每个都是文档落后于进度的,有的甚至几乎没有文档。这会给其他同事还有后来加入的程序员造成很多麻烦,交接项目、review代码的效率也很低。
我用过的IDE有的自带docblock功能,即在函数或者方法头输入/**+回车会自动根据我已经写在函数里的参数、类型、抛出、返回等生成如下的docblock并且支持高亮:
/**
- Add input name to the stack and return personal data
- @param Number index
- @param String name
- @return Object
*/
希望这个建议能被采纳,谢谢。
0 个回复