我今天第一次尝试使用PHPDoc,但很快遇到了问题。
对于每1行变量声明,我至少有5行注释。例:
/**
* Holds path the remote server
* @name ...
* @global ...
*/
$myvar = ...
Run Code Online (Sandbox Code Playgroud)
当然,收益是不错的-但这会将10行的配置文件转换为60行的文件。需要我一辈子来填写,但我还不相信它会在简单的单行代码中增加很多。
这也给我的工作流程带来了麻烦。在我需要进行彻底更改之前,一切都很好。有了我记录良好的文档块,我突然不再需要重构代码,而是需要重写所有这些繁琐的细节。等到你说完为止?哈!这样,文档将永远不会发生。
最重要的是-它迫使我在代码中间使用C风格的/ ** /注释。这使我在开发过程中发疯,因为它剥夺了按需注释掉大块内容的能力。现在注释掉一大段代码,我需要拉出类似:range,s / ^ /#/;的代码。然后稍后撤消。烦人!
长话短说-我喜欢PHPDoc,我喜欢记录良好的代码-但是每一行代码只有5行注释!。有我缺少的功能吗?这是个常见的问题吗?