C# 头文件模板

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

---

我习惯于将标题信息放在/**/标记之间，但StyleCop对此表示不满。

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

[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>

//
//乔纳森·迪金森
//版权所有（c）Jonathan Dickinson 2009
//新BSD
//  
//创建文件和类
//让班级内部化
//  
// 

---

它有着明显的优势——统计（像Ohloh一样）和代码库的验证马上就浮现在人们的脑海中。

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

[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>

//
//乔纳森·迪金森
//版权所有（c）Jonathan Dickinson 2009
//新BSD
//  
//创建文件和类
//让班级内部化
//  
// 

---

它有着明显的优势——统计（就像Ohloh做的那样）和代码库的验证会立刻浮现在脑海中。

永远不要将修订历史记录放在源文件中，这就是您的源代码管理系统的用途

至于标题，我建议#region是一个好主意（因为它是锅炉板，应该从您的关注点中删除，除非您在编辑它，无论它是

/

/还是

/*

）

---

由于

/

更健壮（无嵌套问题）

/

是首选的

永远不要将修订历史记录放在源文件中，这就是您的源代码管理系统的用途

至于标题，我建议#region是一个好主意（因为它是锅炉板，应该从您的关注点中删除，除非您在编辑它，无论它是

/

/还是

/*

）

---

因为

/

更健壮（没有嵌套问题）

/

是首选

你在评论中放什么？一些关于作者、修订历史等文件的样板？是的，我会在标题中包含作者、文件名、版权、修订历史等。你在评论中放什么？一些关于作者、修订历史等文件的样板是的，我会把作者、文件名、版权、修订历史等放在标题中。我喜欢源文件中的注释、修订历史。我觉得有点争议。我喜欢源文件中的注释、修订历史。我觉得有点争议。