Microsoft-ui-xaml: 问题:为什么代码库没有代码分析器(或 linter)?

创建于 2019-07-25  ·  3评论  ·  资料来源: microsoft/microsoft-ui-xaml

根据此 PR上有关基本样式和代码格式的评论数量,我惊讶地发现没有设置分析器(或等效工具)来自动检查诸如空格使用或命名约定之类的问题。

有什么原因不能添加这些吗?

将有两个直接的好处:

  1. 代码将采用一致的格式,这有助于阅读、理解和维护。
  2. 这意味着代码审查不会被琐碎的问题分散注意力,可以专注于代码。 这可以减少代码注释的数量,并防止在关于空行的多次讨论中丢失有价值的问题。

添加这些自动格式检查的缺点可能是现有代码不符合任何规则集,因此打开它会标记大量问题。
如果是这种情况,则可以在以其他方式更改(或添加)项目时打开(或添加分析器)规则,因此并非所有事情都立即完成。
或者,格式不一致通常很容易修复,因此可能只需要几个小时(根据我过去在其他大型项目中的经验)来解决发现的问题,因为工具通常可以自动修复其中的大部分,因此只有例外需要手动干预或审查。
这不是最令人兴奋的工作,但它会随着时间的推移带来价值。
现有代码覆盖率应使其成为低风险更改。

question

所有3条评论

我想可以改进editorconfig或添加

我在想 C# 代码的 StyleCop.Analyzers。 不过,我不确定什么最适合 C++。

不过,我不确定什么最适合 C++。

@RanjeshJ正在努力使 clang-tidy 和 clang-format 能够在代码库上运行,我认为这应该对 C++ 有所帮助。 就我们所见,MSVC 没有很好的 linter。

对于 C#,我们已经设置了新的 editorconfig 内容,应该会在 C# 文件中生效。 如果需要在 C# 中添加更多风格的东西,我们可以做到。 然后,如果像 StyleCop 这样的东西可以帮助走得更远,我们也可以运行它。 但是我在 C# 中没有看到那么多吹毛求疵,所以我认为 editorconfig 主要是在做它的工作。

此页面是否有帮助?
0 / 5 - 0 等级