TomDoc for Ruby - Version 1.0.0-rc1

TomDoc for Ruby - Version 1.0.0-rc1 Purpose TomDoc is a code documentation specification that helps you write precise documentation that is nice to read in plain text, yet structured enough to be automatically extracted and processed by a machine. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to

[crist18]

TomDoc形式のドキュメント。

[efcl]

ruby界隈で使われるコメントドキュメントの記法

[pmint]

80桁（ラテンアルファベットで）とかいってる時点でバカバカしくて話にならない。実行例をコメントにするというのも古くさい。そもそもコードで表現されるものをコメントでも書くというのはアンチパターンだろう。

[uasi]

自然言語に近い形で書ける Ruby のドキュメンテーションフォーマット

[todesking]

ふむー

[mallowlabs]

Ruby のドキュメントの書き方

[Kwappa]

書くようにする