静态 void Main 中的 C# 文档注释答案

【问题标题】：C# documentation comments inside static void Main静态 void Main 中的 C# 文档注释
【发布时间】：2022-11-10 17:57:20
【问题描述】：

我在任何地方都找不到关于 C# 文档评论的答案，所以请解释一下：

如果我在 [someFunc()] 中有一个单独的类和一个方法，那么使用 /// Visual Studio 将为该方法插入一个文档注释。

namespace someNs
{
    internal class someClass
    {   

       /// <summary>
       /// 
       /// </summary>
      public void someFunc(){          
      }        
    } 
}

但是，如果我在“static void Main(string[] args)”中有一个方法然后使用 /// 不起作用。

namespace someNs
{
    internal class Program
    {
        static void Main(string[] args)
        { 
          void someFunc(){
            
          }        
        }
     }   
}

请解释为什么会这样，是否可以通过某种方式添加文档 cmets？

谢谢你。

【问题讨论】：

它是否有效并不重要。只需将您的 /// 或 /* ... */ 注释行放在本地函数上方，就是这样！只有类的实例或静态方法上面的 cmets 才会出现在生成的文档中。

标签： c# visual-studio comments documentation

【解决方案1】：

AFAIK 这些 cmets 的目的是 API 文档。 someFunc() 不属于 Program 的任何可见 API；它是一个实施细节，所以你要求的功能有点毫无意义。

使用常规 cmets 记录特定代码的作用；知道someFunc 存在并需要更多信息的人正在阅读您的源代码，这样就足够了。

【讨论】：