標簽[yuidoc] - 堆棧內存溢出

[英]EmberJS documentation using YUIDoc, Comment Style?

這里我以emberJS控制器為例。如何正確評論使用YUIDoc生成文檔？我有興趣了解emberJS代碼文檔的最佳實踐，所以最后我可以獲得具有完整層次結構的正確doco。任何幫助將受到高度贊賞。 ...

[英]How to document multiple errors with @throws in YUIdoc / jsdoc?

根據YUIdoc的文檔（在這種情況下，它等效於jsdoc），有一個@throws標記可以記錄可能引發的錯誤。指定方法拋出的錯誤。 @throws標簽的結構為@throws {type} description。 {type}是可選的。就我而言，函數中有多個檢查會引發錯誤 ...

YUIDOC-返回的回調的文檔參數

[英]YUIDOC - Document params of returned callback

如何正確記錄返回的回調並返回多個參數。可執行程序： return callback(error, success); ...

yuidoc @namespace與Ember-CLI相關嗎？

[英]Is yuidoc @namespace relevant with Ember-CLI?

@名稱空間 @namespace不應包含整個庫掛起的“ root”或“ global”對象。由於我們有@module給js文件容器。有人可以給我一個最簡單的例子嗎？或引導我進入某個鏈接 ...

如何用部分類替換YUIDoc的索引部分？

[英]How to replace YUIDoc's index partial with the classes partial?

我正在嘗試從我的一個插件上的源代碼構建文檔。現在一切正常，但索引頁為空且無用。我想用部分類的內容替換部分索引，因為這是此插件唯一有用的信息。看起來部分索引無法訪問部分部分中的可用數據？我附上了兩個屏幕截圖，以說明我在說什么。第二個屏幕快照是我想在索引頁面上顯示的。 ...

YUIDocs解析Polymer元素

[英]YUIDocs parse Polymer element

我正在嘗試記錄一系列Polymer Web組件。我過去使用過Polymer / core-docs-viewer ，但發現它不像YUIDocs或其他像JSDocs那樣完整和可擴展。 YUIDocs似乎是記錄較大項目/前端和后端代碼以創建單個可維護文檔源的更好選擇。有沒有辦法讓YUI ...

使用Python子進程運行npm命令

[英]Run npm commands using Python subprocess

我正在嘗試使用YUIDOC自動生成文檔，但我有一個大量使用python的服務器端框架，所以我試圖在python腳本中自動化所有內容。我能夠讓node命令運行正常，但每當我嘗試使用npm安裝的東西時，python就不高興了。我的項目使用Buildout而不是virtualenv，但理想情況 ...

YuiDocs外部數據鏈路使用情況

[英]YuiDocs external data link usage

我有一個需要文檔的ember-cli項目，我使用的是ember-cli-yuidoc插件，這是我的yuidoc.json文件：我想在我的login.js路由鏈接到Ember.Route （它擴展它）。生成的文檔如下所示：上面沒有鏈接到正確的對象，我錯過了什么？ ...

如何使用離線資源構建YUIDoc？

[英]How can I build YUIDoc with offline resources?

當你構建並運行YUIDoc時，它會從http://yui.yahooapis.com/...獲取他的一些資源。這些資源包括樣式表和yui.min.js 如何離線下載和使用這些資源？原因是我們在HTTPS服務器上運行我們的文檔。 YUIDoc始終通過HTTP協議提供文件。 ...

如何使用YUIDoc記錄向量參數？

[英]How to document a vector param with YUIDoc?

任何想法如何用YUIDoc記錄方法參數，其中參數是向量，是三元素的數字數組？這是我到目前為止所做的，將參數簡單描述為“ Array（Number）”： ...

如何使用yuidoc記錄命名空間？

[英]How to document a namespace using yuidoc?

YUIDoc似乎沒有為我的命名空間生成任何文檔。該項目使用顯示模塊設計模式 ...

使用@constructor和@static記錄Ember應用

[英]Documenting Ember apps with @constructor and @static

諸如YUIDocs之類的文檔工具允許您在注釋塊中使用@class標記來標識和描述類（對象類）。每個標識的類都需要一個@static或@constructor標記，定義如下： @constructor指示該類是可實例化的（使用new關鍵字創建）。 @static指示您不應使用 ...

如何記錄Ember App？

[英]How to document an Ember App?

我正在使用YUIdoc。還要別的嗎？那么有人能告訴我如何在Ember中正確記錄模型，控制器，混合和視圖嗎？例如，我試圖記錄這個：編輯我現在使用YUIdoc而不是jsdoc3 ...

如何在yuidoc中添加外部鏈接（grunt-contrib-yuidoc）

[英]How to add add external links in yuidoc (grunt-contrib-yuidoc)

我想我在yuidoc文檔或誤解用法中遺漏了一些東西。我似乎找不到在我的文檔中包含指向外部站點/頁面的鏈接的方法。在評論欄中，我想要有這樣的東西： ...

yuidoc解析但沒有輸出也沒有錯誤

[英]yuidoc parses but no output and no errors

我花了最后4天的時間讓yuidoc解析我的javascript框架，它真的開始讓我發瘋。這是我的json配置文件它正在解析json配置，沒有錯誤。這是輸出：我可以使用命令行以及輸出和主題的默認設置來使其正常工作，但是它沒有我的項目構建和版本信息。 Bootstr ...

使用yuidoc將javascript注釋轉換為.chm文件

[英]convert javascript comments into .chm files using yuidoc

我正在使用YUIDOC將Javascript注釋轉換為chm文件。我先安裝了node.js，然后運行了yuidoc命令，但是當我運行yuidoc E:\\foldername\\filename.js沒有錯誤提示，但警告是路徑參數丟失，並且還會顯示選項。請告訴我如何成功完成此操作。 ...

在yuidoc javascript documentor中忽略標簽

[英]Ignoring tags in yuidoc javascript documentor

是否可以忽略yuidoc中的各種標簽，以使文檔構建過程消息更加有用。我對@ author，@ date等標簽有疑問並且有成千上萬個文件，使得不可能找到“真實的”警告。是否有一種方法可以排除yuidoc中的標簽？ ...

ANT腳本不起作用

[英]ANT Script not working

我有一個ANT腳本，它通過命令行運行yuidoc，但是當我運行此腳本時，它給了我以下錯誤：和相同的命令-> yuidoc -c yuidoc.json。工作，然后我通過cmd提示符運行它。我的ANT腳本： ...

使用yuidoc和ANT腳本生成JavaScript文檔

[英]Generating JavaScript document using yuidoc with ANT script

我正在嘗試使用yuidoc生成JavaScript文檔，以下是我的ANT腳本。我的項目看起來像運行ANT腳本時，它給我錯誤： ...

Ruby中的Yuidoc風格注釋？

[英]Yuidoc-style comments in Ruby?

如何在Ruby中使用YUIDoc注釋？我能想到的最好的方法是：和這個： ...