2011-02-16 33 views
0

「// TODO實現一個完整的類頭」我爲我的C#類項目最終的工作,這是的TODO的該項目之一。我不完全確定它的含義。「// TODO實現一個完整的類頭」

程序,它包含看起來像這樣的頂級:

using System; 
using System.Collections.Generic; 
using System.Linq; 
using System.Text; 

//TODO implement a complete class header 

namespace Payroll 
{ 


[Serializable] 


    public abstract class Employee:IPayable 
    { 
     #region "Variable Declarations" 

     //create an enumeration that keeps track of the type 
     public enum Type 
     { 
      Hourly = 1, 
      Salary = 2, 
      Contract = 3, 
      None = 4 
     }; 
+1

向我們展示了幾行代碼,大約5個請,或1至少是。或者就是你擁有的一切? – servermanfail

+1

是的,C#中沒有這種東西。此外,TODO的位置(在名稱空間之外)很奇怪。也許你的教練對你意味着添加XML註釋的類(你可以用''///類定義上面很容易做到。 – MusiGenesis

回答

6

指定信息,以便其他開發人員都知道這個類做什麼/載。

你可以找到更多信息here<summary>標籤。

Recommended Tags for Documentation Comments

您還可以使用一些軟件稱爲GhostDoc

GhostDoc是一個Visual Studio擴展 是基於其類型, 參數,名稱及其他相關信息 自動生成XML的方法 文檔註釋和 性能。