Documentation 如何记录主要方法？

好的，我有一个.NET控制台应用程序，它的主方法包含在一个程序类中。你知道，通常的情况是：

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

//
///封装应用程序的主入口点。
/// 
班级计划
{
/// 
///应用程序的主要入口点。
/// 
静态void Main（字符串[]参数）
{
//做一些特别的事
}
}

但这似乎远远不够（尽管我的主要例程总是委托给其他类来完成这项工作）

---

你们是如何记录这些事情的？是否有建议或标准

在类级别添加文档，描述控制台程序的实际功能，从而达到目的

在Main方法中，记录所需的参数等，除非您放弃它，“主入口点”就足够了

我倾向于将其交给程序中名为

Run（string[]args）

的实例方法，因此在这种情况下，使用参数/开关选项记录Run方法

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

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

---

在类级别添加文档，描述console程序的实际功能，从而达到目的

在Main方法中，记录所需的参数等，除非您放弃它，“主入口点”就足够了

我倾向于将其交给程序中名为

Run（string[]args）

的实例方法，因此在这种情况下，使用参数/开关选项记录Run方法

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

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

不要，只是不要。 看看你创建的两个示例，比较哪一个更可读

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

不要，就是不要。 看看你创建的两个示例，比较哪一个更可读

---

我敢打赌你会选择没有注释的。

以我的拙见，记录主功能是不值得的，特别是如果你只是想说“应用程序的主入口点”。如果有人不知道

main

是应用程序的主入口点，您不希望它们靠近您的代码：-）

---

如果你想把任何东西放在那里，你可能会记录下预期或接受的参数，但我认为有更好的地方记录程序选项（比如，打印使用情况的使用函数、用户手册、自述文件或其他地方），因为这些信息不仅对开发人员有用，而且对软件用户也很有用。

依我之见，不值得费心去记录主要功能，尤其是如果你只是想说“应用程序的主要入口点”。如果有人不知道

main

是应用程序的主要入口点，您不希望它们靠近您的代码：-）

---

如果你想把任何东西放在那里，你可能会记录下预期或接受的参数，但我认为有更好的地方记录程序选项（比如，打印使用情况的使用函数、用户手册、自述文件或其他地方），因为这些信息不仅对开发人员有用，而且对软件用户也很有用。

文档中添加了一些代码中不明显的内容。工具是用来帮助你的，而不是规定你应该和不应该记录什么

“应用程序的主入口点”没有添加任何内容，所以不要编写它

---

如果有任何不明显的东西，比如参数，请将其记录下来。

文档用于添加代码中不明显的东西。工具是用来帮助你的，而不是规定你应该和不应该记录什么

“应用程序的主入口点”没有添加任何内容，所以不要编写它

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