【Unity】Unity C#基础（十四）注释

---

注释

行注释

// 注释内容

段注释

/* 注释内容 */

XML注释

/// <summary>
/// 注释内容
/// </summary>

/// 是智能注释也称xml注释，会在被编译，并生成xml文件在可执行文件中。会影响编译速度，但不会影响代码执行速度。

一级注释

1. <remarks> 对类型进行描述，功能类似 < summary>，据说建议使用 < remarks>;
2. <summary> 对共有类型的类、方法、属性或字段进行注释；
3. <value> 主要用于属性的注释，表示属性的制的含义，可以配合 < summary > 使用；
4. <param> 用于对方法的参数进行说明，格式：<param name="param_name">value</param>；
5. <returns> 用于定义方法的返回值，对于一个方法，输入 /// 后，会自动添加 < summary>、<param > 列表和 < returns>；
6. <exception> 定义可能抛出的异常，格式：<exception cref="IDNotFoundException">；
7. <example> 用于给出如何使用某个方法、属性或者字段的使用方法；
8. <permission> 涉及方法的访问许可；
9. <seealso> 用于参考某个其它的东东：)，也可以通过 cref 设置属性；
10. <include> 用于指示外部的 XML 注释；

二级注释

1. <c> or <code > 主要用于加入代码段；
2. <para> 的作用类似 HTML 中的 < p > 标记符，就是分段；
3. <pararef> 用于引用某个参数；
4. <see> 的作用类似 < seealso>，可以指示其它的方法；
5. <list> 用于生成一个列表；

另外，还可以自定义 XML 标签 。

注释换行

在 C# 智能注释时，常常希望它能在开发时显示为换行，使得提示更加友好！原来一直想怎么实现，今天偶然发现原来如此简单，只需将 <para>标记用于诸如 <summary>、<remarks>或 <returns>等标记内即可。

注释在开发时换行显示的办法
<para>标记用于诸如<summary>、<remarks> 或 <returns>等标记内，使您得以将结构添加到文本中。

/// <summary> 
/// 基类（第 1 行） 
///<para> 说明：（第 2 行）</para> 
///<para>　　封装一些常用的成员（第 3 行）</para> 
///<para>　　前面要用全角空格才能显示出空格来（第 4 行）</para> 
/// </summary> 
public class MyBase 
{ 
      /// <summary> 
      /// 构造函数（第 1 行） 
      ///<para> 说明：（第 2 行）</para> 
      ///<para>　　初始化一些数据（第 3 行）</para> 
      /// </summary> 
      public MyBase() 
      { 
            // 
            //TODO: 在此处添加构造函数逻辑 
            // 
       } 
} 

TODO注释

TODO注释使用后，可以帮助记录项目中未完成的任务都有哪些。
在代码段里使用TODO注释，如
“//TODO：此处还没测试通过”

在 View -> Task List ，选择 Comments ，即可以查看项目中所有标记 TODO 的位置。

例：

/// <summary>
/// 防御塔目标
/// <para>通过LockTarget锁定目标。</para> 
/// </summary>
protected Transform _target;// TODO 暂时为单个目标，后续需要改成列表。

---

本文大部分内容转自CSDN博主「Leo Chaw」的原创文章，原文链接：https://blog.csdn.net/liankui6027/article/details/111831885

更多内容请查看总目录【Unity】Unity学习笔记目录整理