【Unity】Unity C#基础(十四)注释

这篇具有很好参考价值的文章主要介绍了【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 暂时为单个目标,后续需要改成列表。

【Unity】Unity C#基础(十四)注释


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

更多内容请查看总目录【Unity】Unity学习笔记目录整理文章来源地址https://www.toymoban.com/news/detail-435107.html

到了这里,关于【Unity】Unity C#基础(十四)注释的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Unity C#编程基于《C#高级编程第12版》——C#基础

    类 : 编程中的一种 抽象 的数据类型(用于表现存储数据的类型)。用于描述一组具有相同属性和行为的对象(例如:狗、猫、鸡羊可看作是一个对象,狗的属性可以是名字、花色、体重,行为可以有吃东西,跑步)。 通过类可以方便的实例化出相同类型的对象(前面举例

    2024年01月23日
    浏览(48)
  • Unity 游戏开发、03 基础篇 | C#初级编程

    https://learn.u3d.cn/tutorial/beginner-gameplay-scripting Update(不是按固定时间调用的) 经常用于 移动非物理特性的物体(不是物理对象) 简单定时器 接收输入 FixedUpdate(调用时间间隔相同) 进行任何必要的物理计算(任何物理对象) 最好使用力来定义移动 使用 IDE 的 Unity Event Func

    2024年02月08日
    浏览(65)
  • 【C#基础】unity中结构体的使用

    结构体(Struct)是值类型数据结构,在栈上分配内存,可以包含字段,属性,方法,构造函数。结构体可以实现接口,但是不能继承。在Dots里有大量依靠Struct实现接口来定义Entities数据类型和实现逻辑。 定义结构体 结构体初始化 结构体方法 结构体扩展方法 1.定义结构体 结

    2024年02月11日
    浏览(32)
  • Unity学习笔记(零基础到就业)|Chapter03:C#核心

    这系列的学习笔记主要是根据唐老狮的unity实战路线课程整理的,加入了自己的一些补充和理解,该课程涉及的知识内容非常多,我并未学完,而是根据就业需求挑选学习的,也对后续框架部分进行了一些修改,希望能通过整理并时常阅读这些笔记巩固开发知识,也希望能跟

    2024年02月20日
    浏览(60)
  • git修改commit的注释内容

    要修改 Git 中的 commit 注释内容,可以使用 git commit --amend 命令。具体步骤如下: 运行 git log --oneline 命令,查看需要修改的 commit 的哈希值。 运行 git commit --amend 命令,打开vim编辑器 输入 i 进入编辑模式 修改注释 修改前: 修改后: 按 Esc 退出编辑模式,并且输入 :wq! 保存 验

    2024年02月09日
    浏览(45)
  • IDEA中/** 内容 */注释的快捷键

    在 IDEA 中,你可以使用快捷键 /** 来快速生成 /** 内容 */ 注释。 要使用此快捷键,请在你想要添加注释的代码行上按 Ctrl + / (Windows 系统)或 Command + / (Mac 系统)。如果你想要撤销注释,可以再次按一次快捷键即可。 注意,你必须在代码行的开头才能使用此快捷键。如果你在代码

    2024年02月15日
    浏览(49)
  • 【Unity】 基础交互入门(C#脚本互相调用的方法,含动态绑定脚本)

    脚本A: 在需要被调用的类里这样写: 脚本B: 在其他类里调用: 如果出现无法识别上下文的提示,检查一下以下问题: 1、两个脚本的命名空间是否一致,如果不需要的命名空间可以直接删除。 2、类名是否大写开头,且命名合法,且和文件名一致。 3、更新编译一下保存一

    2024年02月15日
    浏览(53)
  • 【Unity】Socket网络通信(TCP) - 最基础的C#服务端通信流程

    我这里新建了一个C#控制台项目来写服务端代码。 下面是基于C# Socket的最基础服务端通信流程: 创建服务端Socket对象 绑定IP地址和端口 设置最大监听客户端数量 等待客户端连接 收发消息 释放连接 基于上面流程就能实现一个最简单并且能和客户端通信的服务器程序,每个步

    2023年04月16日
    浏览(64)
  • 微信小程序中的app.json文件内容注释

    微信小程序中的app.json文件主要是设置页面的路径,页面的窗口,网络超时时间,设置tabBar,是否开启debug模式。 以下是文件内的内容注释: 注意事项,不需要设置.css/.html/.js/.json后缀,只需要一个文件夹名称及文件名称就好。 添加新页面路径的时候,a设置放在文件夹,b也是

    2024年02月07日
    浏览(50)
  • .net core Api获取所有Action以及注释内容

    有个项目需要获取项目内所有Action,并在凌晨定时任务跑完所有接口检查是否有接口报错,写了如下方法: 实体类: 使用:  

    2024年02月11日
    浏览(44)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包