ã¯ã¦ãªãƒ–ãƒã‚° | 無料ブãƒã‚°ã‚’作æˆã—よã†
本ã¯æ€æƒ³ã‚„未æ¥ã«å½±éŸ¿ã‚’与ãˆã‚‹ã€‚ãŠå‰ã‚‚ブックサンタã«ãªã‚‰ãªã„ã‹ï¼Ÿ 12月ã§ã™ã。ã—ã‚ーã£ã™ï¼(挨拶) 年末ã«ãªã‚‹ã¨å‹Ÿé‡‘ã ã¨ã‹å¯„付ã€åŠ©ã‘åˆã„ã®è©±é¡ŒãŒç››ã‚Šä¸ŠãŒã‚Šã¾ã™ã。 以å‰ã«ã‚‚ã€ã‚¤ãƒ³ã‚¿ãƒ¼ãƒãƒƒãƒˆã«æ©è¿”ã—ã—ã¦ã€äººé¡žã®ç™ºå±•ã«è²¢çŒ®ã—ã¡ã‚ƒãŠã†ã¨ã„ã†è¨˜äº‹ã‚„らã€Be My Eyes ã«ã¤ã„ã¦æ›¸ã„ãŸã‚Šã—ãŸã®ã§ã™ãŒã€ã¡ã‚‡ã£ã¨ã—ãŸè‡ªåˆ†ã®æ™‚é–“ã‚„å°‘ã—ã®ãŠé‡‘…
doxygen用コメントã®æ›¸ãæ–¹
コメントã®æ›¸ãæ–¹(クラス・関数ã®ã‚³ãƒ¡ãƒ³ãƒˆ) ã“ã®ãƒšãƒ¼ã‚¸ã®æœ€æ–°ç‰ˆã¯ä»¥ä¸‹ã®å ´æ‰€ã‚’ã”覧ãã ã•ã„http://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコードä¸ã®ã‚³ãƒ¡ãƒ³ãƒˆã‚’doxygen㮠解説ã«åæ˜ ã•ã›ã‚‹ãŸã‚ã®ã‚³ãƒ¡ãƒ³ãƒˆã®æ›¸ãæ–¹ã§ã™ã€‚æ–°è¦ã«ã‚³ãƒ¡ãƒ³ãƒˆã‚’å…¥ã‚Œã‚‹å ´åˆã¯ä»¥ä¸‹ã®ãƒ«ãƒ¼ãƒ«ã«ã§ãã‚‹ã ã‘従ã†ã‚ˆã†ã«ã—ã¦ãã ã•ã„。 関数内ã®ã‚³ãƒ¡ãƒ³ãƒˆã¯ã“ã®ãƒ«ãƒ¼ãƒ«ã«å¾“ã£ã¦ã„ãŸã ã„ã¦ã‚‚æ„味ãŒã‚ã‚Šã¾ã›ã‚“ ã®ã§é€šå¸¸ã®ã‚³ãƒ¡ãƒ³ãƒˆã§çµæ§‹ã§ã™ã€‚ドã‚ュメント生æˆã«é–¢ä¿‚ã™ã‚‹ã®ã¯ã€ ファイル クラス メンãƒãƒ¼é–¢æ•°ï¼ˆInlineå«ã‚€ï¼‰ メンãƒãƒ¼å¤‰æ•° ã‚°ãƒãƒ¼ãƒãƒ«å¤‰æ•° クラスã®ãƒ¡ãƒ³ãƒãƒ¼ã§ãªã„関数 定数宣言 (#define, enum) ã§ã™ã€‚ doxygenã§èªè˜ã•ã‚Œã‚‹ã‚³ãƒ¡ãƒ³ãƒˆ スタイル doxygenã§ã¯QtスタイルåŠã³JavaDocスタイルã®ã‚³ãƒ¡ãƒ³ トをèªè˜ã—ã¾ã™ï¼Žã‚³ãƒ¡ãƒ³ãƒˆã«ã¯è¦
Doxygen
ソースコード・ドã‚ュメンテーション・ツール Doxygen ã¯ã€C++ã€Cã€Javaã€Objective-Cã€Pythonã€IDL (Corbaã€Microsoft 風)ã€Fortranã€VHDLã€PHPã€C# å‘ã‘ã®ãƒ‰ã‚ュメンテーション・システムã§ã™ã€‚ D ã«ã‚‚ã‚る程度対応ã—ã¦ã„ã¾ã™ã€‚ Doxygen ã«ã¯ã€æ¬¡ã®ï¼“ã¤ã®åˆ©ç‚¹ãŒã‚ã‚Šã¾ã™ã€‚ 文書化ã•ã‚ŒãŸã‚½ãƒ¼ã‚¹ãƒ•ã‚¡ã‚¤ãƒ«ã®ã‚»ãƒƒãƒˆã‹ã‚‰ã€ オンライン・ドã‚ュメント・ブラウザ (HTMLå½¢å¼) やオフラインã®ãƒªãƒ•ã‚¡ãƒ¬ãƒ³ã‚¹ãƒ»ãƒžãƒ‹ãƒ¥ã‚¢ãƒ« (å½¢å¼) を生æˆã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ RTF (MS-Word)ã€PostScriptã€ãƒã‚¤ãƒ‘ーリンク PDFã€åœ§ç¸® HTMLã€Unix man ページ形å¼ã®å‡ºåŠ›ã‚‚サãƒãƒ¼ãƒˆã•ã‚Œã¦ã„ã¾ã™ã€‚ドã‚ュメントã¯ã€ã‚½ãƒ¼ã‚¹ã‹ã‚‰ç›´æŽ¥æŠ½å‡ºã•ã‚Œã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€ãƒ‰ã‚ュメントã¨ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã®ä¸€è²«æ€§ã‚’ä¿ã¤ã“ã¨ãŒã¨ã¦ã‚‚容易ã«ãªã‚Šã¾ã™ã€‚ Doxyge
Let’s use doxygen!
ã¯ã˜ã‚㫠プãƒã‚°ãƒ©ãƒžã«ã¯ã€ãƒ‰ã‚ュメントã€ã¨ãã«ãƒ—ãƒã‚°ãƒ©ãƒ ã®å†…部仕様書を書ãã®ãŒè‹¦æ‰‹ã€ ã¨ã„ã†äººãŒå¤šã„。 ãã®ç†ç”±ã¯æ˜Žã‚‰ã‹ã§ã‚ã£ã¦ã€ãã‚‚ãã‚‚ã€ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã« (ãƒã‚°ã‚‚å«ã‚ã¦)*1 ã™ã¹ã¦ã®ä»•æ§˜ãŒå細もらã•ãšæ›¸ã‹ã‚Œã¦ã„ã‚‹ã®ã«ã€ãªãœã€ã•ã‚‰ã«ãã‚Œã¨ç‹¬ç«‹ã—ãŸä»•æ§˜æ›¸ãŒå¿…è¦ãªã®ã‹ã¨ã€ (åŠã°æœ¬æ°—ã§) æ€ã£ã¦ã—ã¾ã†ã‹ã‚‰ã§ã‚る。 ソースコードã¨ç‹¬ç«‹ã«ãƒ¡ãƒ³ãƒ†ãƒŠãƒ³ã‚¹ã‚’ã—ãªã‘ã‚Œã°ãªã‚‰ãªã„よã†ãªä»•æ§˜æ›¸ã¯ã€ ã„ãšã‚Œã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã¨æ•´åˆæ€§ãŒå–ã‚Œãªããªã£ã¦ã€ç„¡æ„味ãªã‚‰ã¾ã ã—も〠ã‹ãˆã£ã¦å®³ã‚’ãªã™å˜åœ¨ã¨ãªã‚Šæžœã¦ã‚‹ã“ã¨ã‚‚ã‚ã‚‹ã€ã¨ã„ã†ã“ã¨ã‚’〠彼らã¯çµŒé¨“çš„ã«ç†è§£ã—ã¦ã„ã‚‹ã®ã§ã‚る。 (*1) Ruby ã®ä½œè€…ã§ã‚ã‚‹ã€ã¾ã¤ã‚‚ã¨ã‚†ãã²ã‚æ°ã¯ã€ ãã®è‘—者『オブジェクト指å‘スクリプト言語 Rubyã€ã®ä¸ã®ã€Œä»˜éŒ²C Ruby 用語集ã€ã§ã€ 次ã®ã‚ˆã†ã«æ›¸ã„ã¦ã„ã‚‹: ドã‚ュメント ã¾ã¤ã‚‚ã¨ã®è‹¦æ‰‹ãªã‚‚ã®ã€‚å½¼ã¯æ™®æ®µã‹ã‚‰ã€Œã‚½ãƒ¼ã‚¹ãŒãƒ‰ã‚ュメントã 。
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}