將類描述添加到代碼？

我正在完成一個我一直在努力的項目，並且剛剛進行了最後的調整。將類描述添加到代碼？

我想要做的一件事就是在每個類文件的頂部添加類描述（以幫助自己和其他程序員弄清楚發生了什麼）。我的想法是用一堆'/'來爲我寫一些筆記，但也許有更好的方法？在Visual Studio中有內置的方法嗎？

///////////////////////////////////////////////////// 
//             // 
// KillZombies.cs         // 
//             // 
// Description: This class contains blah blah blah // 
//             // 
/////////////////////////////////////////////////////

來源

2010-07-12 sooprise

是的，你應該使用正常XML documentation：

/// <summary> 
/// Describe your class quickly here. 
/// </summary> 
/// <remarks> 
/// Add more details here. 
/// </remarks>

這樣，它會在智能感知顯示，如果你建立與沙堡/ NDoc的你的文檔/ Doxygen的等也將相應地出現。

如果您在類上方的行中鍵入「///」，則應該看到適當的模板以開始使用。有關更多信息，請參閱上面的MSDN鏈接。

來源

2010-07-12 14:20:29

非常好。我使用「///」來描述我的方法，但不知道它是否適合整個類。 – sooprise 2010-07-12 15:13:45

使用XML documentation comments：

/// <summary> 
/// This class performs an important function. 
/// </summary>

當你鍵入三個斜槓Visual Studio將幫助你休息。

不要使用花哨的ASCII格式，因爲當你重構改變類名稱時，你會花費年齡重新格式化所有的盒子，使它們再次很好地排列。

來源

2010-07-12 14:20:47

上述答案中描述的XML文檔註釋是類文件和方法文檔的路徑。

如果您需要每個文件中的非文檔文本的附加信息，例如創建日期，信用點，版權信息等，可以將其添加爲片段或將其添加到適當的Visual Studio模板中。 VS對模板有特殊的變量，如$ username $和$ time $可以用來在每次添加基於模板的新項目時自動插入這些值。

來源

2010-07-12 16:20:53 Rightway

將類描述添加到代碼？

回答

相關問題