是否有PHP linter规则可以防止出现明显的注释？

Question

我在多语言软件代码库（python，JS，java，PHP，C）上工作，我以前的同事在其中评论了所有内容。但是，绝大多数评论完全没有用。例如：

/**
 * Get warning file info
 */
function getWarningFileInfos() {
   ...
}

/**
 * Compute the speed
 */
function computeSpeed() {
    ...
}

我想设置linter规则，以确保不会再次写入此类注释。您是否知道具有这种功能的短绒，或者可以轻松添加此功能的短绒？ （最好是与非英语语言注释兼容的短毛猫）

Answer 1

这是一个问题，需要向您的同事传授什么是评论，以及应该写什么样的评论。

如果您仅自动阻止与该方法同名的注释，则最终会有一些变化：

/**
 * Get warning file info
 */
function getWarningFileInfos() {
   ...
}

成为：

/**
 * Get the warning file info
 */
function getWarningFileInfos() {
   ...
}

...，短绒规则将接受它。这不是真正的问题，可以通过掉毛规则解决。

[如果您可以要求同事提供适当的评论，请他们正确重写评论是一个很好的练习，可以教他们应该写什么评论。

没有短绒毛绒可以将无用的注释转变为有用的注释。

如果您只想删除所有糟糕的注释，可以使用正则表达式：

[/\*.{1,50}\*/将找到所有少于50个字符的注释（编辑器必须支持正则表达式设置“ .matches newline”）。

不进行任何替换，并手动检查文件以确认您没有删除任何有价值的东西。假定大多数这些愚蠢的评论都非常简短。 50个字符是任意的，将其更改为最适合您的字符。