是否需要作者标签?

问题描述 投票:-1回答:1

我能找到的唯一与此相关的其他问题是关于Java doc作者标签的问题。

我认为作者标签只是不必要的噪音,尤其是当如今大多数IDE轻松完成代码注释时。

但是,如果有一个或两个好的用例,而在文档中使用@author标签,我愿意改变主意。

php documentation phpdoc docblocks phpdocumentor2
1个回答
0
投票

与文档块无关的所有内容是[[必需”。毕竟,它们只是评论。

许多项目发布了要求带有某些标签的文档块的编码标准,但这仅仅是一个已达成共识的约定,只能通过同行评审来实施。如果您实际上需要带有某些标签的文档块,则需要使用PHPCS之类的工具,该工具可在预提交挂钩或管道构建步骤中运行。

关于作者标签,​​我发现它们几乎没有用,因为您的源代码控制系统将包含更多详细信息。我唯一使用它们的地方是在公共/共享项目中,我想为此付出功劳。

© www.soinside.com 2019 - 2024. All rights reserved.