我有许多变量的对象,我在评论中声明和解释。我非常彻底地评论了以后使用 phpDoc 进行处理,但是我还没有实际编译文档的经验。
我发现使用 phpDoc 表示法非常烦人,即使我要设置的唯一属性是描述,每个变量也会占用四到六行代码:
/**
* @desc this is the description
*/
var $variable = null;
我想使用以下符号:
# @desc this is the description
var $variable = null;
有没有一种简单的方法可以调整 phpDoc 以接受它,或者当我实际尝试从中编译文档时它会给我带来麻烦?我现在不需要调整(尽管它当然值得赞赏),只是来自知道 phpDoc 的人的声明,这是否可行,而无需重新设计其大部分代码。