最近研究了一些其他大佬寫的插件,其中對腳本注釋的方法和我自己常用的方法很不一樣笆焰,不過他們寫的方法也有很多好處劫谅。
一。我自己的方法是簡單的兩個斜杠,只是在開發(fā)的過程中給自己看的捏检。比如:
//角色的生命
public int health;
二荞驴。新學到的方法是三個斜杠,例子如下:
///<summary>
///角色的生命
///</summary>
public int health;
這種寫法的好處是可以在調(diào)用的時候看到這些注釋贯城,就像下面這張圖一樣熊楼。
用這種方法就可以看到這樣的注釋
三。后來查了查資料能犯,又找到一些這種寫法的擴展鲫骗。例子如下:
/// <summary>
/// <para>角色的生命</para>
/// <para>應當通過調(diào)用固定的函數(shù)改變</para>
/// <para>而不是直接進行修改</para>
///</summary>
public int health;
這里的health按照注釋所說其實應該寫成一個私有的變量,然后用一個公共的函數(shù)來改變他悲雳,這里就先不寫了挎峦。這種方法的效果也挺好,可以實現(xiàn)注釋的換行
四合瓢。這個是另外的一個擴展,好像只能用在函數(shù)的注釋上透典,變量的是不起作用的晴楔。
/// <summary>
/// 角色的生命值
///</summary>
///<param name = 'healthvalue'>
///10
///</param>
public void SetHealth (int healthvalue)
{
}
‘? ’里面的名字應該是和函數(shù)定義的參數(shù)是一樣的。
這樣寫的好處是可以在調(diào)用函數(shù)的時候看到注釋峭咒,也就是你打出這個函數(shù)的名字和半邊括號的時候會看到下面的場景:
五税弃。關(guān)于ToolTip,tooltip也算是一個注釋用的東西,當你寫了一段tooltip之后凑队,你就可以在unity的inspector界面看到這些注釋则果,不過需要你先把光標移動到那個變量上面。
[Tooltip("在這一欄你可以設(shè)置你的初始生命值")]
public int healthValue;
把這段腳本掛上去漩氨,然后把鼠標移到界面上的腳本欄上的 “healthvalue” 這個變量上試試西壮。