有什麼工具可以評論JavaScript代碼嗎？

是否有任何JavaScript評論工具，因爲它在C＃就像幽靈文檔。有什麼工具可以評論JavaScript代碼嗎？

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
function calculatePointDistance(pointA, pointB) 
{ 
    ... 
}

有任何工具來自動添加上述評論。像在C＃代碼鬼文檔所做的：

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
private void calculatePointDistance(pointA, pointB) 
{ 
    ..... 
}

我想做的事情在客戶端上的類似，JavaScript的

來源

2009-10-20 Vijjendra

在Ghostdoc博客有一個從他們不和不打算支持JavaScript團隊成員直接回答。無論如何 - autodocumentig是邪惡的，你最好在編寫代碼時進行一些手動工作 – Bostone 2009-10-20 17:02:21

是（但更喜歡的Javadoc） - look at JSDoc 基本上你使用類似JavaDoc的特殊語法你的意見例如@param就像在下面的例子中，然後解析器將生成好看的HTML輸出，你

/** 
* Shape is an abstract base class. It is defined simply 
* to have something to inherit from for geometric 
* subclasses 
* @constructor 
*/ 
function Shape(color){ 
    this.color = color; 
}

來源

2009-10-20 16:19:15 Bostone

他在Visual Studio插件之後會自動創建XML文檔。 GhostDoc創建文檔存根，因此開發人員不必自行編寫所有文檔。（從我的-1）... – 2009-10-20 20:37:03

你有什麼意見？如果你閱讀我的評論 - Ghostdoc不會爲他做 - 所以我提供了一個有價值的替代人。或者你只是喜歡它？ – Bostone 2009-10-20 21:22:45

他在第三方插件之後，其工作方式與GhostDoc類似，但是適用於Javascript。 GhostDoc首先不會支持JS，這並不意味着別人不會。這個想法是獲得一個爲Javascript添加XML文檔的插件，所以我們不必手動輸入所有的XML元素，而只是輸入他們的值（和類型）。 – 2014-01-27 12:02:58

我沒有親自使用過，但jsdoc-toolkit似乎是你追求的。

來源

2009-10-20 16:20:00 etheros

簡短的答案是否定的，沒有什麼能自動執行文檔。你得到的關閉是手動添加註釋，如jsdoc-toolkit，允許將文檔構建到html頁面中。

有對JavaScript的JavaScript智能文檔以及，它看起來像這樣（請注意這是在函數內部雖然）

function example(var myParameter){ 
    /// <summary>This is an example function</summary> 
    /// <param name="myParameter" type="String">All your string are belong to us.</param> 
    /// <returns type="Boolean" /> 

    return !!myParameter; 
}

您還可以創建JavaScript文件片段。我只需創建一些填寫常用文檔（您喜歡的任何類型）的代碼片段，然後只需鍵入代碼片段即可填寫大部分文檔。

來源

2009-10-20 16:44:19

Javascript沒有輸入參數... – 2014-05-16 18:56:26

只是一個錯字，修復了方法簽名 – 2014-05-23 17:50:52

我還沒有用它來做JavaScript，但是Doxygen has a filter允許它（至少在某種程度上）用來記錄JavaScript。這可能是值得研究的，特別是如果您使用Doxygen也支持的其他語言，那麼您可以擁有一切工具。

看來，JSUnit使用Doxygen作爲其文檔。

來源

2009-10-20 16:48:48

雅，我試過，但我從來沒有得到該過濾器工作:( – 2009-10-21 00:48:39

Sandcastle似乎也支持JavaScript，請參閱http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx。我將它用於C＃，因爲NDoc項目是吐司，但還沒有嘗試過用於JavaScript。我曾經使用上面提到的JSDoc。

來源

2009-10-20 16:59:25 nickytonline

我不知道爲什麼沒有人提到DocStubsJS

來源

2015-09-29 02:44:36

有什麼工具可以評論JavaScript代碼嗎？

回答

相關問題