背景或错误原因：TsLint：注释必须以小写字母开头答案

【问题标题】：Background or reasoning for error: TsLint: comment must start with lowercase letter背景或错误原因：TsLint：注释必须以小写字母开头
【发布时间】：2015-02-13 05:13:11
【问题描述】：

我的项目中收到以下 TsLint 消息：

TsLint：注释必须以小写字母开头

这背后有什么依据吗？我同意我在 TsLint 中遇到的大部分内容，并且我知道可以关闭此警告。

我宁愿理解他们为什么提出这个特定的规则。我阅读了https://github.com/palantir/tslint#supported-rules 的文档，其中解释了规则的作用，但没有解释原因。

【问题讨论】：

我不使用 Typescript，但我怀疑有一个编码约定特别使用以大写字母开头的 cmets。
根据github.com/palantir/tslint/commit/… 的签到历史记录，此规则由github.com/gscshoyru 于 2013 年 12 月 2 日引入。在源头提问可能是获得答案的最佳方式

标签： comments typescript tslint

【解决方案1】：

我在这个asked the author。

这只是一个样式规则，如果不需要，可以放心地忽略

就个人而言，我认为没有理由强制执行此规则，因此我建议禁用或忽略它。

【讨论】：

哇，这是我记得见过的最愚蠢的风格规则。说“cmets 不能是完整的英语句子”是什么意思？我认为“这只是一个风格规则”不足以回答“你为什么认为这是个好主意？”
对于想要利用其 IDE 的“TODO”突出显示/处理的人的额外细节，您可以添加它将在规则中忽略的单词：palantir.github.io/tslint/rules/comment-format跨度>

【解决方案2】：

将此规则添加到您的 tslint.json：

"comment-format": [false, "check-uppercase"]

【讨论】：