是否有 PHP linter 规则来防止明显的注释？

Question

我负责一个多语言软件代码库（python、JS、java、PHP、C），我以前的同事对所有内容都进行了评论。然而，绝大多数评论是完全没有用的。前任：

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

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

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

Answer 1

这是一个需要教导你的同事评论的用途以及应该写什么样的评论的问题。

如果您只是自动阻止与方法同名的注释，最终会出现轻微的变化：

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

变成：

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

...并且 linter 规则会接受它。这实际上并不是一个可以通过 linting 规则解决的问题。

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

没有任何 linter 可以将无用的注释转变为有用的注释。

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

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

不替换任何内容并手动检查文件以检查是否删除了任何有价值的内容。我们假设这些愚蠢的评论大多数都很短。50 个字符是任意的，将其更改为最适合您的值。