二。几种写注释的方法

最近研究了一些其他大佬写的插件,其中对脚本注释的方法和我自己常用的方法很不一样,不过他们写的方法也有很多好处。


一。我自己的方法是简单的两个斜杠,只是在开发的过程中给自己看的。比如:

//角色的生命

public int health;


二。新学到的方法是三个斜杠,例子如下:

///<summary>

///角色的生命

///</summary>

public int health;

这种写法的好处是可以在调用的时候看到这些注释,就像下面这张图一样。


用这种方法就可以看到这样的注释


三。后来查了查资料,又找到一些这种写法的扩展。例子如下:

/// <summary>

/// <para>角色的生命</para>

/// <para>应当通过调用固定的函数改变</para>

/// <para>而不是直接进行修改</para>

///</summary>

public int health;

这里的health按照注释所说其实应该写成一个私有的变量,然后用一个公共的函数来改变他,这里就先不写了。这种方法的效果也挺好,可以实现注释的换行


四。这个是另外的一个扩展,好像只能用在函数的注释上,变量的是不起作用的。

/// <summary>

/// 角色的生命值

///</summary>

///<param name = 'healthvalue'>

///10

///</param>

public void SetHealth (int healthvalue)

{

}

‘  ’里面的名字应该是和函数定义的参数是一样的。

这样写的好处是可以在调用函数的时候看到注释,也就是你打出这个函数的名字和半边括号的时候会看到下面的场景:

如图


五。关于ToolTip,tooltip也算是一个注释用的东西,当你写了一段tooltip之后,你就可以在unity的inspector界面看到这些注释,不过需要你先把光标移动到那个变量上面。

[Tooltip("在这一栏你可以设置你的初始生命值")]

public int healthValue;

把这段脚本挂上去,然后把鼠标移到界面上的脚本栏上的 “healthvalue” 这个变量上试试。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。