如何记录 Main 方法？

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
    }
}

但这似乎严重不足（尽管我的 Main 例程总是委托给其他类来完成这项工作）。

你们是如何记录这些事情的？有推荐或标准吗？

Answer 1

以我的拙见，记录 main 函数的麻烦是不值得的，特别是如果您只想说“应用程序的主要入口点”。如果有人不知道这Main是应用程序的主要入口点，您不希望它们靠近您的代码:-)

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