【Unity】Unity C#基础（十四）注释 |
您所在的位置：网站首页 › eclipse怎么添加注释 › 【Unity】Unity C#基础（十四）注释 |
【Unity】Unity C#基础（十四）注释
|
文章目录
注释行注释段注释XML注释一级注释二级注释注释换行
TODO注释
注释
行注释
// 注释内容
段注释
/* 注释内容 */
XML注释
///
/// 注释内容
///
/// 是智能注释也称xml注释，会在被编译，并生成xml文件在可执行文件中。会影响编译速度，但不会影响代码执行速度。 一级注释 对类型进行描述，功能类似 < summary>，据说建议使用 < remarks>; 对共有类型的类、方法、属性或字段进行注释； 主要用于属性的注释，表示属性的制的含义，可以配合 < summary > 使用； 用于对方法的参数进行说明，格式：value； 用于定义方法的返回值，对于一个方法，输入 /// 后，会自动添加 < summary>、 列表和 < returns>； 定义可能抛出的异常，格式：； 用于给出如何使用某个方法、属性或者字段的使用方法； 涉及方法的访问许可； 用于参考某个其它的东东：)，也可以通过 cref 设置属性； 用于指示外部的 XML 注释； 二级注释 or 主要用于加入代码段； 的作用类似 HTML 中的 < p > 标记符，就是分段； 用于引用某个参数； 的作用类似 < seealso>，可以指示其它的方法； 用于生成一个列表；另外，还可以自定义 XML 标签 。 注释换行在 C# 智能注释时，常常希望它能在开发时显示为换行，使得提示更加友好！原来一直想怎么实现，今天偶然发现原来如此简单，只需将 标记用于诸如 、 或 等标记内即可。 注释在开发时换行显示的办法 标记用于诸如 、 或 等标记内，使您得以将结构添加到文本中。 /// /// 基类（第 1 行） /// 说明：（第 2 行） /// 封装一些常用的成员（第 3 行） /// 前面要用全角空格才能显示出空格来（第 4 行） /// public class MyBase { /// /// 构造函数（第 1 行） /// 说明：（第 2 行） /// 初始化一些数据（第 3 行） /// public MyBase() { // //TODO: 在此处添加构造函数逻辑 // } } TODO注释TODO注释使用后，可以帮助记录项目中未完成的任务都有哪些。 在代码段里使用TODO注释，如 “//TODO：此处还没测试通过” 在 View -> Task List ，选择 Comments ，即可以查看项目中所有标记 TODO 的位置。 例： /// /// 防御塔目标 /// 通过LockTarget锁定目标。 /// protected Transform _target;// TODO 暂时为单个目标，后续需要改成列表。
本文大部分内容转自CSDN博主「Leo Chaw」的原创文章，原文链接：https://blog.csdn.net/liankui6027/article/details/111831885 更多内容请查看总目录【Unity】Unity学习笔记目录整理 |
【本文地址】