Use JSDoc: @alias
Table of Contents Syntax Overview Examples Related Links Syntax @alias <aliasNamepath> Overview The @alias tag causes JSDoc to treat all references to a member as if the member had a different name. This tag is especially useful if you define a class within an inner function; in this case, you can use the @alias tag to tell JSDoc how the class is exposed in your app. While the @alias tag may sound
ã€è¨‚æ£ã‚¨ãƒ³ãƒˆãƒªã€‘jsdoc3ã®ä½¿ã„æ–¹ãŒé–“é•ã£ã¦ã‚‹ã¨æŒ‡æ‘˜ã‚’å—ã‘ãŸã®ã§å†è©•ä¾¡ã—㟠- terurouメモ
以å‰ã€JavaScriptã®APIドã‚ュメント生æˆãƒ„ールを調ã¹ã¦ã¿ãŸã‚‰ã€YUIDocãŒå‰²ã¨ã‚ˆã‹ã£ãŸ - DenkiYagiã¨ã„ã†ã‚¨ãƒ³ãƒˆãƒªã§ã€Œjsdocゴミã£ã½ã„ã€ã¨æ›¸ã„ãŸã®ã ãŒã€ã€Œãれアノテーションã®ä½¿ã„æ–¹ãŒé–“é•ã£ã¦ã‚‹ã€ã¨ãƒ„ッコミãŒå…¥ã£ãŸã®ã§ã€å†è©•ä¾¡ã—ã¦ã¿ãŸã€‚ インストール jsdoc3本体ã®ã»ã‹ã«Java(JRE)ãŒå¿…è¦ã€‚ GitHubã«ã¯npmã§ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã‚³ãƒžãƒ³ãƒ‰ã‚‚書ã„ã¦ã‚ã£ãŸã®ã§ã€ã¦ã£ãã‚ŠNode.jsã§ã‚‚å‹•ãã®ã‹ã¨æ€ã£ãŸã®ã ãŒã€ã‚ˆã見ãŸã‚‰"JSDoc does not currently run on Node.js"ã£ã¦æ›¸ã„ã¦ã‚ã£ãŸã€‚ãªã‚“ã§Node.jsã§å‹•ã‹ãªã„ã‚‚ã®ã‚’npmã§é…布ã—ã¦ã‚‹ã®ã‹ã¯ã¡ã‚‡ã£ã¨æ„味ãŒåˆ†ã‹ã‚‰ãªã‹ã£ãŸã€‚ ドã‚ュメント生æˆå¯¾è±¡ã‚³ãƒ¼ãƒ‰ 以å‰ã®ã‚¨ãƒ³ãƒˆãƒªã‹ã‚‰ã®å¤‰æ›´ç‚¹ã¯ã€@moduleã§ã¯ãªã@namespaceã«å¤‰ãˆãŸã®ãŒå¤§ããªãƒã‚¤ãƒ³ãƒˆã€‚jsdoc3ã§ã¯ã€@mod
JSDoc Toolkit→JSDoc 3移行ガイド | BLOG - DeNA Engineering
ã“ã‚“ã«ã¡ã‚ã€DeNA San Francisco ã®æ¸‹å·ã¨ç”³ã—ã¾ã™ã€‚エンジニアブãƒã‚°ã«ã¯åˆç™»å ´ã§ã™ã€‚ JavaScriptã®ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã‹ã‚‰APIドã‚ュメントを生æˆã™ã‚‹ãƒ„ールã«ã¯ä½•ç¨®é¡žã‹ã‚ã‚Šã¾ã™ãŒã€æ—¥æœ¬èªžã®æ›¸ç±ã‚„ウェブサイトã§ã‚‚æƒ…å ±ãŒå¾—ã‚„ã™ã„ã“ã¨ã‚‚ã‚ã£ã¦ã€JSDocã®ç³»çµ±ãŒå¹…広ã使ã‚ã‚Œã¦ã„ã¾ã™ã€‚Google Closure Compilerã‚‚ã€JSDocã‚’æ‹¡å¼µã—ãŸãƒ‰ãƒƒã‚¯ã‚³ãƒ¡ãƒ³ãƒˆã‚’アノテーションã¨ã—ã¦èªã¿è¾¼ã‚“ã§æœ€é©åŒ–ã—ã¾ã™ã€‚ JSDocã¯é•·ã„期間メンテナンスã•ã‚Œã¦ã„るオープンソースプãƒãƒ€ã‚¯ãƒˆã§ã™ã€‚åˆä»£ã¯Perlã§æ›¸ã‹ã‚ŒãŸJSDoc 1ã§ã™ã€‚ã“ã‚Œã¯ã™ã§ã«ãƒªãƒã‚¸ãƒˆãƒªã‚‚削除ã•ã‚Œã¦ã„ã¾ã™ã€‚ç¾åœ¨æœ€ã‚‚使ã‚ã‚Œã¦ã„ã‚‹ã®ãŒ JSDoc Toolkit (JSDoc 2) ã§ã™ã€‚弊社㮠ngCoreã®ãƒ‰ã‚ュメント ã§ã‚‚使用ã—ã¦ã„ã¾ã™ã€‚ ãŸã ã€ã“れもç¾åœ¨ã¯æ©Ÿèƒ½è¿½åŠ ã‚’åœæ¢ã—ã¦ã„ã¦ã€å¾Œç¶™ãƒ—ãƒãƒ€ã‚¯ãƒˆã® JSDoc 3
JSDoc使ã„方メモ - Qiita
JSDoc 㧠API ドã‚ュメントを生æˆã™ã‚‹æ–¹æ³•ã¨ã€ä¸€éƒ¨ã®ãƒ‰ã‚ュメンテーションタグã®ä½¿ã„æ–¹ã«ã¤ã„ã¦ãƒ¡ãƒ¢ã™ã‚‹ã€‚ #環境 ##OS Windows7 64bit ##Java 1.7.0_51 ##JSDoc 3.2.2 #インストール ##Java Mozilla Rhino を使ã£ãŸæ–¹æ³•ã§ãƒ‰ã‚ュメントを生æˆã™ã‚‹ã®ã§ã€ Java ãŒå¿…è¦ã€‚ インストール方法ã¯å‰²æ„›ã€‚ ##JSDoc 3 GitHub ã‹ã‚‰ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰ã§ãる。 tags ã‹ã‚‰ v3.2.2 ã‚’é¸æŠžã—ã¦ã€ zip ã§ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰ã™ã‚‹ã€‚ zip を解å‡ã—ãŸã‚‰ã€è§£å‡å¾Œã®ãƒ•ã‚©ãƒ«ãƒ€ã«ãƒ‘スを通ã—ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã‹ã‚‰ãƒ˜ãƒ«ãƒ—を表示ã§ãã‚‹ã“ã¨ã‚’確èªã™ã‚‹ã€‚ >jsdoc --help OPTIONS: -t, --template <value> The path to the template to use. Default: path/to/
1
ランã‚ング
ランã‚ング
ランã‚ング
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
http://usejsdoc.org/
Google Code Archive - Long-term storage for Google Code Project Hosting.
GitHub - jsdoc/jsdoc: An API documentation generator for JavaScript.
{{#tags}}- {{label}}
{{/tags}}