Question

是否有用于.NET源代码文件的标准模板？

我习惯将标题信息放在/ * * /标签之间，但StyleCop正在抱怨这些。

Answer 1

永远不要将修订历史记录放在源文件中，这就是源控制系统的用途。

至于标题我会建议#region是一个好主意（因为它是锅炉板，应该从您的关注中移除，除非您正在编辑它，如果它是/无关紧要/或/*。

由于//更健壮（没有嵌套问题），因此首选//

Answer 2

只是一个想法，绝不是一个标准（或者就此而言，可能是一个好主意）。您是否考虑过使用属性？ E.g。

[Author("Jonathan Dickinson")]
[Copyright("Copyright (c) Jonathan Dickinson 2009")]
[RevisionHistory(
        "jcd: Made the class.",
        "jcd: Made the class internal.")]
[License("GPL", LicenseType = LicenseType.CopyLeft)]
// Etc.
class Foo
{
}

任何人都有任何想法为什么这会是一种可怕的做法？

在任何情况下 - StyleCop主要用于商业项目（通常不做代码标题）。换句话说 - 忽略或禁用friggen警告。时间和时间我读过StyleCop和FXCop太挑剔了。我已经看到了以下格式的标题注释。

// <code-header>
//  <author>Jonathan Dickinson</author>
//  <copyright>Copyright (c) Jonathan Dickinson 2009</copyright>
//  <license href="license.txt">New BSD</license>
//  <revisions>
//    <revision initials="jcd">Made the file and class</revision>
//    <revision intiails="jcd">Made the class internal</revision>
//  </revisions>
// </code-header>

它具有明显的优势 - 统计数据（如Ohloh确实）和代码库的验证立即浮现在脑海中。

头文件模板

2 个答案: