static void Main 内的 C# 文档注释

ser*_*yiv 0 c# documentation comments visual-studio

我在任何地方都找不到有关 C# 文档注释的答案,所以请解释一下:

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

namespace someNs
{
    internal class someClass
    {   
        /// <summary>
        /// 
        /// </summary>
        
        public void someFunc()
        {          
        }        
    } 
}
Run Code Online (Sandbox Code Playgroud)

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

namespace someNs
{
    internal class Program
    {
        static void Main(string[] args)
        { 
            void someFunc()
            {
            }        
        }
    }   
}
Run Code Online (Sandbox Code Playgroud)

请解释为什么会这样,是否可以通过某种方式添加文档注释?

谢谢。

InB*_*een 6

AFAIK 这些注释的目的是 API 文档。someFunc()不属于任何可见 API 的一部分Program;这是一个实现细节,因此您要求的功能有点毫无意义。

使用常规注释来记录该特定代码段的作用;任何知道 的someFunc存在并需要更多信息的人都在阅读您的源代码,所以这应该足够了。