在 .NET（或一般）中创建文档的正确方法是什么？
What is the proper way of creating documentation in .NET (or general)?
我刚刚开始我的软件开发职业生涯，我得到了第一个项目来了解它。
让我非常惊讶的是，约 30% 的代码实际上是
的注释
<param name="">
<summary>
等等。我认为 .NET 开发人员明白我的意思。
关键是，它让这段代码变得非常难看。我知道它有助于 Swagger 制作文档，它有助于 IDE 描述方法及其参数，但是......它也使代码变得丑陋。
这是普遍做法吗？或者可以用不同的方式完成吗？
顺便说一句，我知道它可以隐藏在 IDE 中，但这不是我要问的。
举个例子...检查Microsoft Reference Source。
文件是必要的，如果你不这样做，在别人看来很难看。 Understandable/maintainable代码是适合所有人的好代码。
你不能离开它，你也不能。
如下所示在代码中包含文档注释是编写文档的首选方式。按照这种方法，开发人员可以在他们的 IDE 中阅读文档，或者可以为网络生成 HTML 版本。
/// <summary>
/// An effective trap for capturing delicious, tasty roadrunners.
/// </summary>
public class RoadrunnerTrap
{
}
话虽如此，您也可以清楚地命名您的 类、变量和方法，从而避免编写尽可能多的文档。没有文档通常是不好的，但太多明显或重复的文档更糟。
我刚刚开始我的软件开发职业生涯，我得到了第一个项目来了解它。
让我非常惊讶的是，约 30% 的代码实际上是
的注释<param name="">
<summary>
等等。我认为 .NET 开发人员明白我的意思。
关键是，它让这段代码变得非常难看。我知道它有助于 Swagger 制作文档，它有助于 IDE 描述方法及其参数，但是......它也使代码变得丑陋。
这是普遍做法吗？或者可以用不同的方式完成吗？
顺便说一句，我知道它可以隐藏在 IDE 中，但这不是我要问的。
举个例子...检查Microsoft Reference Source。
文件是必要的，如果你不这样做，在别人看来很难看。 Understandable/maintainable代码是适合所有人的好代码。
你不能离开它，你也不能。
如下所示在代码中包含文档注释是编写文档的首选方式。按照这种方法，开发人员可以在他们的 IDE 中阅读文档，或者可以为网络生成 HTML 版本。
/// <summary>
/// An effective trap for capturing delicious, tasty roadrunners.
/// </summary>
public class RoadrunnerTrap
{
}
话虽如此，您也可以清楚地命名您的 类、变量和方法，从而避免编写尽可能多的文档。没有文档通常是不好的，但太多明显或重复的文档更糟。