æ™‚é›¨å ‚ã‚’æ”¯ãˆã‚‹æŽ¡ç”¨You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
徹底討論ï¼ç¤¾å†…ã®æŠ€è¡“æƒ…å ±å…±æœ‰ãƒ„ãƒ¼ãƒ« - GitHub Wiki, Qiita:Team, esa.io （特別編：トップエンジニアãŸã¡ã®å¤œ 『シドニアã®é¨Žå£«ã€è¦³è³žä¼šï¼†åº§è«‡ä¼š ～Part4～） | Tokyo Otaku Mode Blog
ã“ã‚“ã«ã¡ã¯ã€ãƒ©ã‚¤ã‚¿ãƒ¼ã®å²¡ç”°å¤§ã§ã™ã€‚ ãŠå¾…ãŸã›ã—ã¾ã—ãŸã€‚特別編「トップエンジニアãŸã¡ã®å¤œã€ã®Part4ã‚’ãŠå±Šã‘ã—ã¾ã™ã€‚ ※Part1～3未èªã®æ–¹ï¼†å†…容を忘れã¦ã—ã¾ã£ãŸæ–¹ã¯ã€Part1・Part2・Part3を一èªã—ã¦ã‹ã‚‰ãŠæ¥½ã—ã¿ãã ã•ã„ï¼ ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã‚’æˆåŠŸã•ã›ã‚‹ãŸã‚ã«å¿…è¦ãªãƒ¢ãƒŽã¨ã‚³ãƒˆã«ã¤ã„ã¦ã¯å‰å›žãŠä¼ãˆã—ãŸé€šã‚Šã€‚ルールã¨ãƒžãƒŠãƒ¼ãªãã—ã¦æˆã‚Šç«‹ãŸãªã„ã“ã¨ã¯è¨€ã†ã¾ã§ã‚‚ãªãã€ãã®ã“ã¨ã‚’メンãƒãƒ¼ï¼ˆã¨ãã«æ–°äººï¼‰ã«å¾¹åº•ã•ã›ã‚‹ãŸã‚ã«ã€ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã‚’ç©æ¥µçš„ã«å°Žå…¥ã—ã¦ã„る伊藤æ°ã¯ã€ã‚¬ã‚¤ãƒ‰ãƒ©ã‚¤ãƒ³ã‚’ドã‚ュメント化ã™ã‚‹ã“ã¨ã«ã‚ˆã‚Šæ„è˜ã®å…±æœ‰ã‚’図ã£ã¦ã„ã‚‹ã¨ã„ã†ã€‚ãã®éš›ã«æ´»ç”¨ã—ã¦ã„ã‚‹ã®ãŒã€æŠ€è¡“æƒ…å ±å…±æœ‰ã‚µãƒ¼ãƒ“ã‚¹Qiita:Teamã§ã‚ã‚‹ã€‚å €æœ¨æ°ã®å£ã‹ã‚‰ã€ŒQiita:Teamã€ã¨ã„ã†è¨€è‘‰ãŒç™ºã›ã‚‰ã‚Œã‚‹ã‚„ã„ãªã‚„ã€å‚åŠ ãƒ¡ãƒ³ãƒãƒ¼ä¸€åŒãŒã“ã‚Œã«é£Ÿã„ã¤ãã€åº§è«‡ä¼šã¯ãƒãƒ¼ãƒ 内ã«ãŠã‘ã‚‹æƒ…å ±å…±æœ‰ã«é–¢ã™ã‚‹è©±é¡Œã§æŒã¡åˆ‡ã‚Šã«ãªã£ã¦ã„ã£ãŸâ€¦â€¦ã€‚ãªãŠã€
JsDoc Toolkitを使ã†ï¼
「JsDoc Toolkitを使ã†ï¼ã€ã¯ã€JavaScriptドã‚ュメンテーションツールã§ã‚ã‚‹JsDoc Toolkitã®ä½¿ã„方を紹介ã™ã‚‹ã‚µã‚¤ãƒˆã§ã™ã€‚JsDoc Toolkitã¯éžå¸¸ã«å„ªã‚ŒãŸãƒ„ールã§ã™ãŒã€ã¾ã¨ã¾ã£ãŸæ—¥æœ¬èªžã®æƒ…å ±ãŒå°‘ãªã„よã†ãªã®ã§ä½•ã¨ãªã作ã£ã¦ã¿ã¾ã—ãŸã€‚ ã“ã®ã‚µã‚¤ãƒˆã®å†…容ã¯ã‚ãã¾ã§ç®¡ç†äººå€‹äººã®ç†è§£ã«åŸºã¥ãã‚‚ã®ã§ã™ã€‚ã”利用ã¯è‡ªå·±è²¬ä»»ã§ãŠé¡˜ã„ã—ã¾ã™ã€‚ 記載ã•ã‚Œã¦ã„ã‚‹æƒ…å ±ã¯ãƒãƒ¼ã‚¸ãƒ§ãƒ³ 2.4.0 時点ã®ã‚‚ã®ã§ã™ã€‚
JavaScript対応APIドã‚ュメント生æˆãƒ„ールã®ã¾ã¨ã‚
JavaScriptã«ã‚‚JavaDocã®ã‚ˆã†ãªã‚³ãƒ¡ãƒ³ãƒˆã‹ã‚‰APIドã‚ュメントを生æˆã™ã‚‹ãƒ„ールãŒã„ã‚ã„ã‚ã¨ã‚ã‚‹ãŸã‚ã€ã©ã®ã‚ˆã†ãªã‚‚ã®ãŒã‚ã‚‹ã‹å°‘ã—調ã¹ã¦è¦‹ã¾ã—ãŸã€‚基本的ãªã‚³ãƒ¡ãƒ³ãƒˆã®æ›¸ãæ–¹ã¯å¤§ä½“ãŒJSDocã¨å…±é€šã—ã¦ã„ã‚‹ã®ã§ã€ç‰¹ã«è¨€åŠãŒãªã‘ã‚Œã°ãã®ã‚ˆã†ãªæ›¸ãæ–¹ãŒé€šã‚‹ã‚‚ã®ãŒå¤šã„ã§ã™ã€‚ JsDoc Toolkit JSDoc(開発åœæ¢)ã®å¾Œç¶™ã§ã‚ã‚‹ãŸã‚最も有åã ã¨æ€ã„ã¾ã™ã€‚ ç¾åœ¨ã¯ver2ã§æ©Ÿèƒ½è¿½åŠ ã®ãƒªã‚¯ã‚¨ã‚¹ãƒˆã¯åœæ¢ã•ã‚Œã¦ã„ã¾ã™ãŒã€JSDoc 3ãŒé–‹ç™ºä¸ã¨ãªã£ã¦ã„ã‚‹ãã†ã§ã™ã€‚ æƒ…å ±é‡ã‚‚ãã“ãã“ã‚ã‚‹ã¨æ€ã†ã®ã§ã€APIドã‚ュメント生æˆãƒ„ール関係ã«ã¤ã„ã¦èª¿ã¹ã‚‹æ™‚ã«å‚考ã«ãªã‚‹ã€‚ Closure Compilerãªã©ã„ã‚ã„ã‚ãªã¨ã“ã‚ã§ä½¿ã‚ã‚Œã¦ã„ãŸã‚Šã—ã¾ã™ã€‚ -JsDoc Toolkitを使ã†ï¼ – トップページ YUI Doc Yahooã®YUI Libraryã§ä½¿ç”¨ã•ã‚Œã¦ã„るドã‚ュメント生æˆãƒ„ールã§ã™ã€‚ Py
コードリーディングã«Doccoを使ã†ã¨æ—ã‚‹ã‹ã‚‚ã—ã‚Œãªã„件
Doccoã¯ã€CoffeeScriptã«ã‚³ãƒ¡ãƒ³ãƒˆã‚’ã¤ã‘ã¦ãƒ‰ã‚ュメントを出力ã§ãるパッケージã§ã™ã€‚コードã¨ã‚³ãƒ¡ãƒ³ãƒˆã‚’å·¦å³ã«è¡¨ç¤ºã•ã‚Œã‚‹ã‚¹ã‚¿ã‚¤ãƒ«ã§ã™ã€‚コメントã«ã¯MarkdownãŒä½¿ãˆã¾ã™ã€‚ インストール インストールã¯npmã€‚è¿½åŠ ã§PygmentsãŒå¿…è¦ã§ã™ã€‚ $ npm install -g docco $ sudo easy_install Pygments 使ã„æ–¹ 先日ã®ã‚¨ãƒ³ãƒˆãƒªãƒ¼ã§ç´¹ä»‹ã—ãŸãƒ–ãƒã‚°ã‚¢ãƒ—リCoffee-Boxを例ã«ã‚³ãƒ¡ãƒ³ãƒˆã‚’書ãã¨ã“ã†ãªã‚Šã¾ã™ã€‚ (CoffeeBoxã®ç´¹ä»‹ã¯ 『Node.js「脱ã€åˆå¿ƒè€…ï¼CoffeeBoxã§ãƒ–ãƒã‚°ã®ä½œã‚Šæ–¹ã‚’å¦ã¼ã†ï¼ã€ã‚’å‚ç…§ã—ã¦ãã ã•ã„） # ***server.coffee*** ã¯ã€Coffee-Boxã®ã‚¨ãƒ³ãƒˆãƒªãƒ¼ãƒã‚¤ãƒ³ãƒˆã§ã™ã€‚ # [express](http://expressjs.com/)ã‚’èªã¿è¾¼ã¿ã¾ã™ã€‚ express = re
YUIDocを使ã£ã¦ã¿ãŸã‚ˆ - 四角é©å‘½å‰å¤œ
JavaScriptå‘ã‘ã®ãƒ‰ã‚ュメントジェãƒãƒ¬ãƒ¼ã‚¿ã¨ã„ã†ã¨ã€JSDoc toolkitã¨ã‹Doccoãªã©ãŒã‚ã‚Šã¾ã™ãŒã€YUIDocãŒç¨‹ã‚ˆã手軽ãªæ„Ÿã˜ã§ä½¿ã£ãŸã“ã¨ã‚‚ãªã‹ã£ãŸã®ã§ä½¿ã£ã¦ã¿ã¾ã—ãŸã€‚ 昔ã¯Javaã‹ãªã‚“ã‹ã§ä½œã‚‰ã‚Œã¦ãŸæ°—ãŒã™ã‚‹ã®ã§ã™ã‘ã©ã€ã„ã¾ã§ã¯npmモジュールã«ãªã£ã¦ã‚‹ã®ã§ã™ã。node.js + npmãŒå…¥ã£ã¦ã‚‹ãªã‚‰ã¨ã£ã¦ã‚‚インストールã¯ã¨ã£ã¦ã‚‚ç°¡å˜ã€‚ インストール npmã‹ã‚‰ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã—ã¾ã™ã€‚ $ npm install -g yuidocjs ã§ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã™ã‚‹ã¨ã‚ˆã„ã‹ã¨ã€‚今回ã¯ã‚°ãƒãƒ¼ãƒãƒ«ã«ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã—ãŸããªã‹ã£ãŸã®ã§ $ npm install yuidocjs ã§ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã—㦠$ ./node_modules/.bin/yuidoc ã§ä½¿ã†ã“ã¨ã«ã—ã¾ã™ã€‚ é©å½“ãªã‚³ãƒ¼ãƒ‰ã‚’書ã é©å½“ãªJavaScriptã®ã‚³ãƒ¼ãƒ‰ã‚’書ãã¾ã™ã€‚ index.js /** * Classク
JavaScriptã®APIドã‚ュメント生æˆãƒ„ールを調ã¹ã¦ã¿ãŸã‚‰ã€YUIDocãŒå‰²ã¨ã‚ˆã‹ã£ãŸ - terurouメモ
JavaScriptã®APIドã‚ュメント生æˆãƒ„ール（ã„ã‚ゆるjavadocã¿ãŸã„ãªã‚‚ã®ï¼‰ã‚’使ã„ãŸããªã£ãŸã®ã§ã€è‰²ã€…調ã¹ã¦ã¿ãŸã€‚ jsdoc3 使ã„æ–¹ãŒé–“é•ã£ã¦ã‚‹ã¨æŒ‡æ‘˜ã•ã‚ŒãŸã®ã§ã€è¨‚æ£ã‚¨ãƒ³ãƒˆãƒªæ›¸ãã¾ã—㟠→ ã€è¨‚æ£ã‚¨ãƒ³ãƒˆãƒªã€‘jsdoc3ã®ä½¿ã„æ–¹ãŒé–“é•ã£ã¦ã‚‹ã¨æŒ‡æ‘˜ã‚’å—ã‘ãŸã®ã§å†è©•ä¾¡ã—㟠- DenkiYagi JavaScriptã®APIドã‚ュメント生æˆãƒ„ールã¯ç¾åœ¨ã‚‚jsdocç³»ãŒä¸»æµã®ã‚ˆã†ãªã®ã§ã€ãã®æœ€æ–°ç³»çµ±ã®jsdoc3ã‚’ã¾ãšè©¦ã—ã¦ã¿ãŸã€‚ jsdoc3/jsdoc · GitHub zipをダウンãƒãƒ¼ãƒ‰ã—ã¦å±•é–‹ã™ã‚‹ã¨ã€JREã•ãˆã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã•ã‚Œã¦ã„ã‚Œã°ã™ãã«ä½¿ãˆã‚‹ï¼ˆRhinoã®jarãŒåŒæ¢±ã•ã‚Œã¦ã„る）。 ã§ã€å®Ÿéš›ã«ä½¿ã£ã¦ã¿ãŸã®ã ãŒã€ä»¥ä¸‹ã®ã‚ˆã†ã«å³æ™‚関数内ã«ãƒ‰ã‚ュメントコメントを書ã„ã¦ã„るケースã§ã¯ãƒ‰ã‚ュメントãŒæ£å¸¸ã«ç”Ÿæˆã•ã‚Œãªã„。 /** @module SampleModule */ v
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
Inch CI
enja-oss
Maruta
{{#tags}}- {{label}}
{{/tags}}