代码之家  ›  专栏  ›  技术社区  ›  Nick

如何确保每个源文件都有注释头、githook或npm脚本?

  •  0
  • Nick  · 技术社区  · 6 年前

    由于我们项目中的法律要求,每个源代码文件的顶部必须有几行:

    1 //// File: filename.js
    2 //// Description: Blah blah blah
    3 //// Copyright: Blah Blah Blah
    4 //// Changes: Blah
    

    是,这与版本控制信息是冗余的。我们没有选择,所以我想尽可能地自动化它。如果有任何文件缺少此项,则应发出警告,就像过梁一样。

    我没有看到任何关于这个的ESLint规则,但是它可以被添加(通过插件?)

    我们正在使用createreact应用程序,所以据我所知,只有在弹出时才可能添加lint规则,而我们不想这样做。

    我找不到任何Node.js特定于强制执行标题注释的内容。我能找到的唯一一件事就是这种强制执行 an answer about StyleCop 对于带有死链接的C#。

    0 回复  |  直到 6 年前