Question

好的，所以我有一个.NET控制台应用程序，它的Main方法包含在Program类中。你知道，通常：

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

由于我已经开始如此严格地使用StyleCop和FxCop，我已经变得非常挑剔，确保一切都得到妥善记录。

然后它打了我。我绝对不知道如何正确记录Program和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
    }
}

但这似乎非常不合适（尽管我的主要例程总是委托其他类来完成工作）。

你们怎么记录这些东西？有推荐或标准吗？

Answer 1

以我的拙见，记录主要功能并不值得，特别是如果你只是说“应用程序的主要入口点”。如果有人不知道Main是应用程序的主要入口点，那么您不希望它们靠近您的代码： - ）

如果您要在那里放置任何内容，您可以记录预期或接受的参数是什么，但我认为有更好的地方来记录程序选项（例如，打印用法的使用函数，用户手册，自述文件），或其他地方），因为该信息不仅对开发人员有用，而且对软件用户也有用。

Answer 2

文档是在代码中添加一些不明显的东西。工具可以帮助您，而不是指示您应该和不应该记录的内容。

“应用程序的主要入口点”不添加任何内容，因此请勿编写。

如果有任何不明显的参数，请记录下来。

Answer 3

在类级别添加描述控制台程序实际的功能的文档，这是它的目的。

在Main方法中，记录所需的参数等，除非你把它关掉，“主入口点”就足够了。

我倾向于将其交给Program中名为Run(string[] args)的实例方法，因此在这种情况下，请使用arguments / switches选项记录Run方法。

然后我的Main（）方法的主体看起来像：

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

Answer 4

不要，只是不要。只需看看你创建的那两个样本，并比较哪个样本更具可读性？

我敢打赌你会选择没有评论的那个。

如何记录Main方法？

4 个答案: