JSDOC常用注釋

常用標簽

@module
標明當前文件模塊,在這個文件中的所有成員將被默認為屬于此模塊,除非另外標明

@submodule
針對模塊的劃分,處于@module之下

@class

標示一個類或者一個函數(shù)

@constructor

當使用對象字面量形式定義類時,可使用此標簽標明其構(gòu)造函數(shù)

@callback

標明此方法是一個回調(diào)函數(shù)

@event

標明一個可觸發(fā)的事件函數(shù),一個典型的事件是由對象定義的一組屬性來表示。

@constant

常量標識

@member/@var

記錄一個基本數(shù)據(jù)類型的成員變量

@method

標記一個方法或函數(shù)

@param

標記方法參數(shù)及參數(shù)類型

@property

標明一個對象的屬性

@readonly

只讀

@return

標明返回值、類型及描述

@type

描述代碼變量的類型

@description

如果在注釋開始描述可省略此標簽

@enum

一個類中屬性的類型相同時,使用此標簽標明

@example

示例,代碼可自動高亮

@exports

標識此對象將會被導出到外部調(diào)用

@ignore

忽略此注釋塊

@link

內(nèi)聯(lián)標簽,創(chuàng)建一個鏈接,如 {@link http://github.com Github}

@name

指定一段代碼的名稱,強制 JSDoc 使用此名稱,而不是代碼里的名稱

@namespace

指定一個變量為命名空間變量

@static

描述一個不需實例即可使用的變量

@summary

對描述信息的短的概述

@throws

描述方法將會出現(xiàn)的錯誤和異常

@todo

描述函數(shù)的功能或任務(wù)

@tutorial

插入一個指向向?qū)Ы坛痰逆溄?/p>

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,558評論 25 708
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,992評論 19 139
  • 前言 人生苦多,快來 Kotlin ,快速學習Kotlin! 什么是Kotlin? Kotlin 是種靜態(tài)類型編程...
    任半生囂狂閱讀 26,282評論 9 118
  • 在瀏覽器打開React單頁應(yīng)用,習慣上會把整個應(yīng)用所有的JS文件一次性加載完。什么?暫時不需要的JS文件也要加載,...
    一米米尺閱讀 1,346評論 2 2
  • 今天小妮子和王同學要來長沙準備明天的考試,盡管后天要交論文了,盡管我還沒用知網(wǎng)查重也不想,盡管之前時間一大把,...
    辛德瑞拉_7d9e閱讀 196評論 0 0