[C#基础_小知识] 代码注释

最新推荐文章于 2025-06-17 15:00:31 发布

原创最新推荐文章于 2025-06-17 15:00:31 发布 · 324 阅读

0 ·

CC 4.0 BY-SA版权

C#基础专栏收录该内容

4 篇文章

订阅专栏

本文介绍了几种常见的代码注释方法，包括代码折叠、普通注释及自动类和函数注释等。通过这些技巧可以帮助提高代码的可读性和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.代码折叠(可嵌套)

输入#region后按Tab键自动补全

#region MyRegion

    #region SubRegion

    #endregion SubRegion

#endregion MyRegion

2.普通注释

int i;

//行注释(仅注释本行)
//int i;

/* 块注释(不可嵌套)
int i;
i = 3;
*/

/*自动块注释：在 "/*" 所在行按下回车，自动生成下一行注释，输入 "*/" 结束注释
*
* */

3.自动类、函数注释 ///

在类或函数前输入 /// ，会自动获得注释

using Systerm;

/// <summary>
/// 
/// </summary>
public class TestClass {

    /// <summary>
    /// 
    /// </summary>
    /// <param name="i"></param>
    /// <param name="f"></param>
    /// <returns></returns>
    private string DoSomething(int i, float f)
    {
        return "xxx";
    }
}