如何记录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方法？

回答

相关问题