如何記錄Main方法？

好的，所以我有一個.NET控制檯應用程序，它包含在Program類中的Main方法。要知道，一般的：如何記錄Main方法？

class Program 
{ 
    static void Main(string[] args) 
    { 
     // Do something spectactular 
    } 
}

自從我使用了StyleCop和的FxCop如此嚴格的開始，我已經成爲一種挑剔的關於確保一切正常記錄的。

然後它打我。我有絕對不知道如何正確記錄程序和Program.Main。

我認爲，從長遠來看，你可以用下面去：

/// <summary> 
///  Encapsulates the application's main entry point. 
/// </summary> 
class Program 
{ 
    /// <summary> 
    ///  The application's main entry point. 
    /// </summary> 
    static void Main(string[] args) 
    { 
     // Do something spectactular 
    } 
}

，但似乎遠遠不夠的（儘管事實上，我的主要套路總是委託給其他類做的工作）。

你們如何記錄這些事情？有沒有推薦或標準？

來源

2009-11-18 Mike Hofer

在我的愚見中，記錄主要功能並不值得，特別是如果你只是想說「應用程序的主要入口點」。如果有人不知道Main是應用程序的主要入口點，則不希望它們位於您的代碼附近的任何位置:-)

如果您要在其中放置任何東西，您可以記錄預期或接受的參數是什麼，但我認爲有更好的地方可以記錄程序選項（比如打印用法的用戶函數，用戶手冊，自述文件或其他地方），因爲這些信息不僅對開發人員有用，對軟件用戶也很有用。

來源

2009-11-18 16:30:51

在類級別添加文檔描述控制檯程序實際上做什麼，所以它的目的。

在Main方法中，記錄所需的參數等，除非您手動關閉，「主入口點」確實足夠。

我傾向於將它交給名爲Run(string[] args)的程序中的實例方法，因此在這種情況下，請使用arguments/switches選項記錄Run方法。

我的Main（）方法的主體然後簡單地樣子：

Program prog = new Program(); 
prog.Run(args);

來源

2009-11-18 16:30:08

不要，就是不要。看看你創建的2個樣本，並比較哪些樣本更具可讀性？

我敢打賭，你會選擇一個沒有評論的人。

來源

2009-11-18 16:30:33

文檔可以添加代碼中不明顯的內容。工具可以幫助你，而不是規定你應該記錄什麼和不應該記錄什麼。

「應用程序的主要入口點」不會添加任何內容，因此請勿寫入它。

如果有任何不明顯的參數，請記錄下來。

來源

2009-11-18 16:33:00

如何記錄Main方法？

回答

相關問題