jsdoc塊和內聯標籤

2021-07-05 07:21:09 字數 1188 閱讀 7448

原文:

概覽

jsdoc支援兩種不同型別的標籤:

塊標籤通常會提供有關您的**的詳細資訊,如函式接受的引數。行內標籤通常鏈結到檔案的其他部分,類似於html中的錨標記()。

塊標籤總是以符號(@)開頭。每塊標記後面必須跟乙個換行符,在jsdoc注釋中除了最後一塊標記。

行內標籤也以符號開頭。然而,內聯標籤及其文字必須用花括號()。該表示行內標籤的結束。如果你的標籤的文字中包括右花括號(}),則必須用領先的反斜線(\)進行轉義。你並不需要使用乙個換行符在內聯標籤後。

大多數jsdoc標籤是塊標籤。一般來說,當這個**是指「jsdoc標籤,」我們真正的意思是「塊標籤」。

例子

在下面的例子中,@param 是乙個塊標記,和是乙個內聯標記:

塊和內聯標籤jsdoc注釋

/**

* set the shoe's color. use to set the shoe size.

* * @param color - the shoe's color.

*/shoe.prototype.setcolor = function(color) ;

您可以使用內聯標籤在乙個描述中,如上圖所示,或塊標記中,如下圖所示:

塊標籤內使用內嵌標籤

/**

* set the shoe's color.

* * @param color - the shoe color. must be an enumerated

* value of .

*/shoe.prototype.setcolor = function(color) ;

當您使用多個塊標記在jsdoc注釋中,它們必須通過換行分開:

用換行分隔的多個塊標籤

/**

* set the color and type of the shoelaces.

* * @param color - the shoelace color.

* @param type - the type of shoelace.

*/shoe.prototype.setlacetype = function(color, type) ;

html塊標籤,內聯標籤

1.內聯標籤和塊級標籤的主要區別 塊元素內聯元素 獨佔一行,預設情況下,其寬度自動填滿其父元素寬度 相鄰的行內元素會排列在同一行裡,直到一行排不下,才會換行,其寬度隨元素的內容而變化 可以設定width,height屬性 行內元素設定width,height屬性無效 可以設定margin和paddi...

塊級標籤與內聯標籤

學習的初期,我們就要知道,標準文件流等級森嚴。標籤分為兩種等級 比如h1標籤和span,同時設定寬高,來看瀏覽器效果,那麼你會發現 行內元素和塊級元素的區別 非常重要 行內元素 塊級元素 塊級元素和行內元素的分類 在以前的html知識中,我們已經將標籤分過類,當時分為了 文本級 容器級。從html的...

HTML常用標籤 內基本標籤(塊級標籤和內聯標籤)

html常用標籤 內基本標籤 塊級標籤和內聯標籤 一.系列標籤 n的取值範圍是1 6,從小到大,用來表示標題。1 6doctype html 7 html lang en 8 head 9 meta charset utf 8 10 title yinzhengjie title 11head 12...