Question

我知道这一定是一个简单的问题。但我试着用谷歌搜索，但无法找到一个合适的结果。我管理着一支庞大的团队，有很多人在我这里工作。我想确保我的开发人员编写的每个函数都应该在它之前发表评论。在我的tslint文件中添加规则是有意义的。

如何强制我的开发人员在开始功能之前添加评论（如下所示）？

function dupe(array){
  const set = new Set;
  return array.find(n => set.has(n) || (set.add(n), false));
}

Answer 1

我对此进行了更多的研究，发现tslint中有一条规则来强制执行评论和好事，它是高度可配置的。

我使用了满足我要求的以下规则：

"completed-docs": [
      true,
      {
        "enums": true,
        "functions": {
          "visibilities": ["exported"]
        },
        "methods": {
          "location": "instance",
          "privacies": ["public", "protected"]
        }
      }
    ]

有关详细信息，请查看此内容 - https://palantir.github.io/tslint/rules/completed-docs/

强制开发人员在功能中添加注释

1 个答案: