[B! documentation] InoHiroã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

InoHiro id:InoHiro

documentationã«é–¢ã™ã‚‹InoHiroã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (10)

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

${{author_name}}$
{{author_name}}{{created}}
{{ #comment }}{{ comment }}{{ /comment }}
- {{ label }}

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

æ®‹æ¥ã‚‚æ¸›ã‚‰ã›ã‚‹!? ä¸Šç´šã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ã«ãªã‚‹ãŸã‚ã®Design Docè¶…å…¥é–€
æ®‹æ¥ã‚‚æ¸›ã‚‰ã›ã‚‹!? ä¸Šç´šã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ã«ãªã‚‹ãŸã‚ã®Design Docè¶…å…¥é–€ï¼šãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆæˆåŠŸç¢ºçŽ‡å‘ä¸Šã®è¿‘é“ã¨ã¯ï¼Ÿï¼ˆ3ï¼‰ï¼ˆ1/3 ãƒšãƒ¼ã‚¸ï¼‰ ITã‚·ã‚¹ãƒ†ãƒ é–‹ç™ºã®å•é¡Œç‚¹ã®ä¸€ã¤ã§ã‚ã‚‹ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã®å¤±æ•—ã€‚æœ¬é€£è¼‰ã§ã¯ã€ã“ã‚Œã‚’é˜²ãæ–¹æ³•ã¨ã—ã¦ãŠå‹§ã‚ã—ãŸã„3ã¤ã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ç´¹ä»‹ã—ã¦ã„ãã€‚ä»Šå›žã¯ã€ã€ŒæŠ€è¡“è¦–ç‚¹ã€ã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã¨ã—ã¦ã€2000å¹´ä»£ä»¥é™æ³¨ç›®ã•ã‚Œã¦ã„ã‚‹ã€ŒDesign Docã€ã«ã¤ã„ã¦è§£èª¬ã—ã¾ã™ã€‚ IT æŠ€è¡“ãŒãƒ“ã‚¸ãƒã‚¹ã«è²¢çŒ®ã—ã¦ã„ããŸã‚ã«ã¯ã€ã¾ãšã¯ã‚·ã‚¹ãƒ†ãƒ é–‹ç™ºã‚’æˆåŠŸã•ã›ã‚‹ã“ã¨ãŒé‡è¦ã§ã™ã€‚æœ¬é€£è¼‰ã€Œãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆæˆåŠŸç¢ºçŽ‡å‘ä¸Šã®è¿‘é“ã¨ã¯ï¼Ÿã€ã§ã¯ã€ã‚·ã‚¹ãƒ†ãƒ é–‹ç™ºã‚’æˆåŠŸã•ã›ã‚‹ãŸã‚ã«ã€ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ãŒæžœãŸã™å½¹å‰²ã®é‡è¦æ€§ã¨ã€ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã«ã‚ˆã‚‹ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã®é‡è¦æ€§ã«ã¤ã„ã¦è§£èª¬ã—ã¦ãã¾ã—ãŸã€‚ é€£è¼‰1å›žã®ã€Œãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã¯æœ€å¼·ã®ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ãƒ„ãƒ¼ãƒ«ã§ã‚ã‚‹â€•â€•Joelã®æ©Ÿèƒ½ä»•æ§˜æ›¸å…¥é–€ã€ã€ç¬¬2å›žã®ã€Œã‚µãƒ³ãƒ—ãƒ«ä¾‹ã«è¦‹ã‚‹
InoHiro 2018/03/02
documentation

design-doc
ãƒªãƒ³ã‚¯
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usa ble documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
InoHiro 2014/12/09
ruby

documentation
ãƒªãƒ³ã‚¯
ReadTheDocsã§Sphinxãƒ›ã‚¹ãƒ†ã‚£ãƒ³ã‚°ã¯ç£çŸ³ï¼ˆã«ãªã‚‹äºˆå®šï¼‰ - YAMAGUCHI::weblog
ã¯ã˜ã‚ã« ã“ã‚“ã«ã¡ã¯ã€Sphinx-Users.jpã®è³‘ã‚„ã‹ã—æ‹…å½“ã§ã™ã€‚æœ€è¿‘PHPç•Œéšˆã§ã‚‚äººæ°—ã®é«˜ã„ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆç”Ÿæˆãƒ„ãƒ¼ãƒ«Sphinxã§ã™ãŒã€ã¿ãªã•ã‚“æ¥½ã—ã„Sphinxãƒ©ã‚¤ãƒ•ã‚’é€ã£ã¦ã„ã¾ã™ã§ã—ã‚‡ã†ã‹ã€‚ã•ã¦ã€Sphinxã§ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ä½œã£ãŸå ´åˆã€ä¸€ç•ªã‚ãƒ£ãƒƒãƒãƒ¼ãªã®ã¯HTMLã ã¨æ€ã†ã‚“ã§ã™ãŒã€ãã®ãƒ›ã‚¹ãƒ†ã‚£ãƒ³ã‚°ã¯ã¿ãªã•ã‚“ã©ã†ã•ã‚Œã¦ã„ã¾ã™ã‹ï¼Ÿ Sphinx-Users.jpã«ã„ãã¤ã‹ãƒ›ã‚¹ãƒ†ã‚£ãƒ³ã‚°ã®æ–¹æ³•ã‚’ç´¹ä»‹ã—ã¦ã‚ã‚Šã¾ã™ãŒã€ä»Šæ—¥ã¯å‰²ã¨æ–°ã—ã„ãƒ›ã‚¹ãƒ†ã‚£ãƒ³ã‚°æ–¹æ³•ã®ReadTheDocsã‚’ã”ç´¹ä»‹ã—ã¾ã™ã€‚ ReadTheDocsã£ã¦ãªã«ï¼Ÿ Home | Read the Docs rtfd/readthedocs.org Â· GitHub ReadTheDocsã¯2010å¹´ã®Django Dashã§ä½œæˆã•ã‚ŒãŸã‚³ãƒ¼ãƒ‰ã‚’å…ƒã«å…¬é–‹ã•ã‚Œã¦ã„ã‚‹ã‚µãƒ¼ãƒ“ã‚¹/ãƒ©ã‚¤ãƒ–ãƒ©ãƒªã§ã™ã€‚å¤–éƒ¨ã«å…¬é–‹ã•ã‚Œã¦ã„ã‚‹Sphinxã®ãƒ¬ãƒã‚¸ãƒˆãƒªï¼ˆG
InoHiro 2013/08/28
documentation
ãƒªãƒ³ã‚¯
Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Automatic deploy previews Preview your documentation on every pull request. Never guess what you're shipping again. Ideal developer experience Write documentation with Git and your favorite text editor. Developers and writers both love docs as code. Work privately or publ icly Share content with j
InoHiro 2013/08/28
documentation
ãƒªãƒ³ã‚¯
https://sphinx-users.jp/doc10/tutorial.html
InoHiro 2013/08/21
sphinx

documentation
ãƒªãƒ³ã‚¯
Python Docstrings
InoHiro 2013/08/21
python

documentation
ãƒªãƒ³ã‚¯
/ - æµ·è±¹æ—¥è¨˜
{ä»Šå¹´|ä»Šæœˆ|ä»Šé€±|ä»Šæ—¥}ã‚‚ä½•%éŽãŽã¾ã—ãŸ ã‚†ãæ²³ã®æµã‚Œã¯çµ¶ãˆãšã—ã¦ã€ã—ã‹ã‚‚ã‚‚ã¨ã®æ°´ã«ã‚ã‚‰ãš (é´¨é•·æ˜Ž:è˜å) FESTINA LENTE ã‚†ã£ãã‚Šæ€¥ã’ (ãƒãƒ¼ãƒžå¸å›½åˆä»£çš‡å¸ ã‚¢ã‚¦ã‚°ã‚¹ãƒˆã‚¥ã‚¹) ç«‹æ´¾ã«ã§ããŸã®ã§ã‚ã‚Œã°ã€ãã‚Œã¯ååˆ†æ—©ãã§ããŸã“ã¨ã«ãªã‚‹ (ãƒãƒ¼ãƒžå¸å›½åˆä»£çš‡å¸ ã‚¢ã‚¦ã‚°ã‚¹ãƒˆã‚¥ã‚¹) æµ·è±¹æ—¥è¨˜ ã¸ã‚ˆã†ã“ã ã“ã®ã‚µã‚¤ãƒˆã¯ã€å€‹äººçš„ãªè¦šæ›¸ã‚’æ®‹ã—ã¦ãŠãã‚µã‚¤ãƒˆã§ã™ è‡ªåˆ†ã¯ã€ã‚ˆãã“ã‚“ãªã“ã¨ã‚’ã—ã¾ã™ ä½•ã‹ã®å›°ã‚Šã”ã¨ã‚„èˆˆå‘³ã®èµ´ãã¾ã¾ã«ã€ã„ã‚ã„ã‚èª¿ã¹ã‚‹ æ•°ã‹æœˆå¾Œã«ã€ãã®ã“ã¨ã‚’å¿˜ã‚Œã¦ã—ã¾ã£ã¦ã€åŒã˜ã“ã¨ã«ã¤ã„ã¦ã„ã‚ã„ã‚èª¿ã¹ã‚‹ã€‚ã—ã‹ã—ã€ãã®ã†ã¡ã€æ•°ã‹æœˆå‰ã®è‡ªåˆ†ãŒã€åŒã˜ã“ã¨ã‚’åŒã˜ã‚ˆã†ã«èª¿ã¹ã¦ã„ãŸã“ã¨ã«æ°—ã¥ã ãã‚Œã¯ä¸æ¯›ãªã®ã§ã€è¦šæ›¸ã‚’æ®‹ã—ã¦ãŠã“ã†ã¨ã„ã†ã‚ã‘ã§ã™ (ä¸»äººå…¬ã®ã‚¢ãƒªã‚¹ã«æŽ´ã¾ã‚Œã¦ã€ãƒã‚§ã‚¹ç›¤ã®ã¯ã‚‹ã‹ã‹ãªãŸã¾ã§æŒã¡ä¸Šã’ã‚‰ã‚ŒãŸã“ã¨ã®ã‚ã‚‹ãƒã‚§ã‚¹ã®çŽ‹ã•ã¾ãŒã€å½“æ™‚ã®ã“ã¨æ€ã„å‡ºã—) çŽ‹ã•ã¾ã€Œã‚ã®çž¬é–“ã®ææ€–ã¨ã„ã£ãŸã‚‰ã€ã‚
InoHiro 2013/08/21
python

pydoc

documentation
ãƒªãƒ³ã‚¯
Doxygen
è¨å®š ãƒ•ã‚©ãƒ¼ãƒžãƒƒãƒˆ è¨å®šãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€Makefile ã«ä¼¼ãŸæ§‹é€ ã‚’æŒã¤ã€è‡ªç”±å½¢å¼ã® ASCII ãƒ†ã‚ã‚¹ãƒˆãƒ•ã‚¡ã‚¤ãƒ«ã§ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ã¯ Doxyfile ã¨ã„ã†åå‰ã«ãªã‚Šã¾ã™ã€‚ ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€doxygen ã«ã‚ˆã£ã¦è§£æžã•ã‚Œã¾ã™ã€‚ æ›¸å¼è¨å®šã®ãŸã‚ã€ã‚¿ãƒ–ã‚„æ”¹è¡Œã‚³ãƒ¼ãƒ‰ã‚’å…¥ã‚Œã‚‰ã‚Œã¾ã™ã€‚ ã‚¹ãƒ†ãƒ¼ãƒˆãƒ¡ãƒ³ãƒˆã¯ã€å¤§æ–‡å—ã¨å°æ–‡å—ãŒåŒºåˆ¥ã•ã‚Œã¾ã™ã€‚ ãƒ•ã‚¡ã‚¤ãƒ«å†…ã®ã©ã“ã«ã§ã‚‚ã‚³ãƒ¡ãƒ³ãƒˆã‚’ç½®ãã“ã¨ãŒã§ãã¾ã™ (ã‚¯ã‚©ãƒ¼ãƒˆã®ä¸ã‚’é™¤ã)ã€‚ ã‚³ãƒ¡ãƒ³ãƒˆã¯ã€# æ–‡å—ã§å§‹ã¾ã‚Šã€è¡Œã®çµ‚ã‚ã‚Šã¾ã§ç¶šãã¾ã™ã€‚ ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€æœ¬è³ªçš„ã«ã¯ã€ä»£å…¥æ–‡ã®ãƒªã‚¹ãƒˆã‹ã‚‰ãªã£ã¦ã„ã¾ã™ã€‚ å„ã‚¹ãƒ†ãƒ¼ãƒˆãƒ¡ãƒ³ãƒˆã¯ã€å¤§æ–‡å—ã§æ›¸ã‹ã‚ŒãŸ TAG_NAME ã®å¾Œã« = æ–‡å—ã¨1ã¤ä»¥ä¸Šã®å€¤ãŒç¶šã„ãŸã‚‚ã®ã§ã™ã€‚ åŒã˜ã‚¿ã‚°ã¸ã®ä»£å…¥ãŒ 2å›žä»¥ä¸Šç¾ã‚ŒãŸå ´åˆã¯ã€æœ€å¾Œã®ä»£å…¥æ–‡ã ã‘ãŒæœ‰åŠ¹ã«ãªã‚Šã¾ã™ã€‚ å¼•æ•°ã«ãƒªã‚¹ãƒˆã‚’æŒ‡å®šã™ã‚‹ã‚ªãƒ—ã‚·ãƒ§ãƒ³ã«ã¤ã„ã¦ã¯ã€= ã®ã‹ã‚ã‚Šã« += æ¼”ç®—åã‚’ä½¿ã£ã¦ã€ãƒªã‚¹ãƒˆã«æ–°ã—ã„å€¤
InoHiro 2013/08/20
documentation

Doxygen
ãƒªãƒ³ã‚¯
Python pydocã®ä½¿ã„æ–¹ã€æ›¸ãæ–¹ã¨htmlå‡ºåŠ›ã®æ–¹æ³• - Symfoware
Javaã®JavaDocã¨åŒæ§˜ã€Pythonã«ã‚‚pydocãŒã‚ã‚‹ã“ã¨ã¯çŸ¥ã£ã¦ã„ãŸã®ã§ã™ãŒã€ ä½¿ã£ãŸã“ã¨ãŒãªã‹ã£ãŸã®ã§ã€ã¡ã‚‡ã£ã¨èª¿ã¹ã¦ã¿ã¾ã—ãŸã€‚ helpã§ã®è¡¨ç¤º pythonã®ã‚¤ãƒ³ã‚¿ãƒ¼ãƒ—ãƒªã‚¿ãƒ¼ã‚’èµ·å‹•ã—ã¦ã€help()ã‚’å®Ÿè¡Œã™ã‚‹ã¨ã€ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«ã« è¨˜è¼‰ã•ã‚ŒãŸãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆãŒè¡¨ç¤ºã§ãã‚‹ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ è©¦ã—ã«ã€httplibã¨å…¥åŠ›ã—ã¦ã¿ã‚‹ã¨ã€ã“ã‚“ãªæ„Ÿã˜ã§ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«ã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆãŒè¡¨ç¤ºã•ã‚Œã¾ã—ãŸã€‚ ãªã‚“ã ã‹ã‹ã£ã“ã„ã„ã§ã™ã€‚ ã€Œqã€ã¨å…¥åŠ›ã™ã‚‹ã¨ã€helpãƒ¢ãƒ¼ãƒ‰ã‚’æŠœã‘ã¦ã€ã‚¤ãƒ³ã‚¿ãƒ¼ãƒ—ãƒªã‚¿ãƒ¼ã«æˆ»ã‚Šã¾ã™ã€‚ æ›¸ã„ã¦ã¿ã‚‹ è¨˜è¼‰ã—ãŸå†…å®¹ãŒã©ã®éƒ¨åˆ†ã«è¡¨ç¤ºã•ã‚Œã‚‹ã®ã‹çŸ¥ã‚ŠãŸã‹ã£ãŸã®ã§ã€ é©å½“ã«ã‚µãƒ³ãƒ—ãƒ«ã‚’æ›¸ã„ã¦ã¿ã¾ã—ãŸã€‚ # -*- coding:utf-8 -*-"""ãƒ•ã‚¡ã‚¤ãƒ«ã®å…ˆé ã«æ›¸ã„ãŸã‚³ãƒ¡ãƒ³ãƒˆ"""__author__ = "ä½œè€… <mai [email protected]>"__status__ = "productio
InoHiro 2013/08/20
pydoc

documentation

python
ãƒªãƒ³ã‚¯
NAMAKESUGI | YARDãŒã™ã”ã„
Flexã‚„Ruby on Railsãªã©ã§ä½¿ã„æ–¹ã¨ã‹ã‚’è‡ªåˆ†ãŒå¾Œã§ã‚ã‹ã‚‹ã‚ˆã†ã«ãƒ¡ãƒ¢ã—ã¦ãŠããƒ–ãƒã‚°ã€‚æœ€è¿‘ã¯Flexç³»ã«é£½ãã¦ã¾ã™ã€‚ [ruby]rdocã¯æ¨ã¦åŽ»ã‚‰ã‚Œã¦YARDã«ãªã£ãŸ[gem] çš†ã•ã‚“ã¯rubyã‚„railsã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ã©ã®ã‚ˆã†ã«ä½œæˆã•ã‚Œã¦ã„ã¾ã™ã‹ï¼Ÿ rdocã ã¨javadocã¿ãŸã„ãªã“ã¨ãŒã§ããªã„ãƒ¼ãƒ¼ãƒ¼ã¨ã„ã†ã“ã¨ã«æ‚©ã‚“ã§ã„ã¾ã›ã‚“ã‹ï¼Ÿ ãã‚“ãªã¨ãã«ã¯ã“ã‚Œã‚’ãŠè©¦ã—ãã ã•ã„ã€‚ yardã¨ã¯ rdocã®é€²åŒ–ç‰ˆ ã™ã”ãç¶ºéº—ãªãƒªãƒ•ã‚¡ãƒ¬ãƒ³ã‚¹ãŒä½œæˆã§ãã¾ã™ å‚è€ƒURLã¨ã—ã¦yardã®å‡„ã•ã‚’è¡¨ã—ãŸã®ãŒã“ã®ãƒšãƒ¼ã‚¸ã§ã™ã€‚ => Gemãƒªãƒ•ã‚¡ãƒ¬ãƒ³ã‚¹ Gemã«ç™»éŒ²ã•ã‚Œã¦ã„ã‚‹ãƒ©ã‚¤ãƒ–ãƒ©ãƒªã‚’yardã§è¡¨ç¤ºã—ã¦ã„ã¾ã™ã€‚ ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ« ä»Šå›žåˆ©ç”¨ã—ãŸã®ã¯0.6.4ã§ã™ã€‚ãªãŠrdocã®ç”Ÿæˆã‚’å‹æ‰‹ã«ã—ã¾ã™ãŒã€å¤±æ•—ã—ã¾ã™ã€‚ gem install yard ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆç”Ÿæˆæ–¹æ³• RAILSç‰ã®ãƒ«ãƒ¼ãƒˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã§å®Ÿè¡Œ
InoHiro 2011/07/04
ruby

documentation
ãƒªãƒ³ã‚¯
1