二治拿。幾種寫注釋的方法

最近研究了一些其他大佬寫的插件,其中對腳本注釋的方法和我自己常用的方法很不一樣笆焰,不過他們寫的方法也有很多好處劫谅。


一。我自己的方法是簡單的兩個斜杠,只是在開發(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” 這個變量上試試西壮。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市叫惊,隨后出現(xiàn)的幾起案子款青,更是在濱河造成了極大的恐慌,老刑警劉巖霍狰,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件抡草,死亡現(xiàn)場離奇詭異,居然都是意外死亡蔗坯,警方通過查閱死者的電腦和手機康震,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來宾濒,“玉大人腿短,你說我怎么就攤上這事。” “怎么了答姥?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵铣除,是天一觀的道長。 經(jīng)常有香客問我鹦付,道長尚粘,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任敲长,我火速辦了婚禮郎嫁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘祈噪。我一直安慰自己泽铛,他們只是感情好,可當我...
    茶點故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布辑鲤。 她就那樣靜靜地躺著盔腔,像睡著了一般。 火紅的嫁衣襯著肌膚如雪月褥。 梳的紋絲不亂的頭發(fā)上弛随,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天,我揣著相機與錄音宁赤,去河邊找鬼舀透。 笑死,一個胖子當著我的面吹牛决左,可吹牛的內(nèi)容都是我干的愕够。 我是一名探鬼主播,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼佛猛,長吁一口氣:“原來是場噩夢啊……” “哼惑芭!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起挚躯,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤强衡,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后码荔,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體漩勤,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年缩搅,在試婚紗的時候發(fā)現(xiàn)自己被綠了越败。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,137評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡硼瓣,死狀恐怖究飞,靈堂內(nèi)的尸體忽然破棺而出置谦,到底是詐尸還是另有隱情,我是刑警寧澤亿傅,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布媒峡,位于F島的核電站,受9級特大地震影響葵擎,放射性物質(zhì)發(fā)生泄漏谅阿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一酬滤、第九天 我趴在偏房一處隱蔽的房頂上張望签餐。 院中可真熱鬧,春花似錦盯串、人聲如沸氯檐。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽冠摄。三九已至,卻和暖如春几缭,著一層夾襖步出監(jiān)牢的瞬間耗拓,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工奏司, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人樟插。 一個月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓韵洋,卻偏偏與公主長得像,于是被迫代替她去往敵國和親黄锤。 傳聞我的和親對象是個殘疾皇子搪缨,可洞房花燭夜當晚...
    茶點故事閱讀 45,086評論 2 355