頭文件模板

Question

是否有一個用於.NET源代碼文件的標準模板？

我習慣於將標題信息放在/ * * /標記之間，但StyleCop正在抱怨這些。

Answer 1

只是一個想法，絕不是一個標準（或者對於這個問題，可能是一個好主意）。你有沒有想過使用屬性？例如。

[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）和代碼庫的驗證馬上想到。

Answer 2

永遠不要將修訂歷史記錄放入源文件，這就是您的源代碼管理系統的用途。

至於標題我會建議＃地區是一個好主意（因爲它是鍋爐板，應該從您的關注中刪除，除非你正在編輯它在這一點上它並不重要，如果它/ /或/* 。

由於//更強勁（沒有嵌套問題）//優先