文檔工具很少或不完整代碼

我正在查找文檔工具。我的需求非常具體，但我認爲這似乎是存在的。我有搜索高和低，我的最後一招是stackoverflow用戶的頭腦。文檔工具很少或不完整代碼

這是我面臨的問題。在像JavaScript這樣的語言中，它並不具有古典對象的東方本質。

但有辦法做到這一點與原型屬性。（如果你有點混淆coffeescript輸出或打字稿）。

所以，現在一旦我們到達這裏，我們需要記錄代碼，但我們沒有我們現在想要使用的某些關鍵字。如class和extend。

如果你是一個有點糊塗這裏有一個例子

function Person(name){ 
    this.name=name; 
} 

function Person(name){ 
    return { 
     name:name 
    } 
} 

function Person(){ 
    console.log("hi i am a person"); 
}

所有這一切都是有效的JavaScript，它是該死的幾乎不可能沒有身爲人告訴函數或類的意圖。

例如

function Person(){ 
    console.log("hi i am a person"); 
} 

///This is obviously not a class only an idiot would think so 

Person.prototype.setUp=function(config){ 
    this.name=config.name; 
    this.age=config.age; 
} 
///Ha-ha! got you it is going to be a class

這使其很難記錄。與我袒護我想展示問題，然後爲什麼我想要我想要的。

所以我想要的是一種創建不依賴於代碼的文檔的方法。如果我可以在一個單獨的文件夾中創建它。

如果我有這樣一棵樹。

src/ 

    People 

      Person.js 

      Man.js 

      Woman.js 

doc/ 

    index.html 

    People 
      Person.html 

      Man.html 

      Woman.html

手工做這件事的問題是創建每個文件。給他們一個頭標籤和樣式，並且如果東西被移動，它會產生相關鏈接會產生問題。

我想要的東西就像從phpdoc生成的所有樣式文件和所有包含的文檔，我只需瀏覽一邊的類。隨着文件夾結構和一切包括在內。

KK所以我試過了。我嘗試使用降價。停止的理由。很難創建可以點擊並輕鬆導航的鏈接。記住這個假設是一個GUI前端。開發人員可以瀏覽頁面並理解語言的某些特徵。

是的，當你上傳github的降價是解析和理解，但它不夠好需要在前端和本地工作。

Wiki 是的，但沒有。這需要一個設置。這需要設置較少的功能。

EverNote你認爲如何通過使用Evernote的github同步。你可以鏈接並點擊跳轉到不同的頁面，但沒有選擇使用VC。

Microsoft Word。是。我們可以鍵入，但要格式化需要相當多的時間。

HTML文檔。這是迄今爲止關閉的工作，但需要太多時間才能將這些頭標與相關鏈接添加到樣式標記中。

選項將所有html放在同一個文件夾中，並使用_ as /這很麻煩。

如何獲得像phpdoc文檔沒有任何代碼生成。我想輸入它，然後生成它。

沒有訂閱服務。

我聽說過一些似乎可以在乳膠中找到解決方案的詞，但還沒有弄清楚。

來源

2014-06-06 Lpc_dark

你看看jsdoc和其他人一樣嗎？你也可以在評論中使用js文件中的html，稍後將它拉出來，或通過以文本/ html格式提供文件來就地使用。 – dandavis

就像我想要一個乾淨的方式來擴展。我不認爲這個jsdoc有和@extend。由於EcmaScript 6，我們將有擴展的東西，但我無法找到目前的文件的方式 –

我已經雙重檢查jsdoc不支持擴展 –

我並不標誌着這個作爲最終的答案了，但它絕對看起來很有希望http://daux.io/

來源

2014-06-06 17:03:20

文檔工具很少或不完整代碼

回答

相關問題