ReVIEW記法 基本文法最速マスター - 達人出版会日記
今日はソニーリーダーの話じゃなくて、当社で発売している本の方の話題です。 達人出版会が発行しているドキュメントは、今のところ全てReVIEW記法という記法を使って書かれています。ReVIEWのアプリ（というか単純なコマンドライン用のコマンド）を使えば、EPUBやLaTeXに自動変換できたり、InDesignを使って印刷用原稿にすることもできます。実際、高橋が執筆した『Rubyレシピブック第3版』などは、ReVIEWを使って書いた原稿から、InDesignによって印刷用に使われています。 ReVIEW記法の真面目な紹介はサイトの方にある程度書いてありますが、簡単なチュートリアルということで、はてなっぽく書いてみます。というか「はてな記法 基本文法最速マスター」を参考にしてます。 基礎 プレーンテキスト 多くのWiki記法や簡易マークアップ言語と同じ様に、特別な記法(後述)を使った表現以外は全
RDoc Documentation
RDOC - Ruby Documentation System このパッケージはRdocとSimpleMarkupというふたつのコンポーネントを含んでいます。 RdocとはRubyのソースファイルに対するドキュメントを生成するアプリケーションです。 JavaDocと同様に、ソースを解析し、クラス、モジュール、メソッドの定義を抜き出して きます(include,requireもです)。そしてこれらの内容とその直前に書かれた コメントを併合し、ドキュメントを出力します(現在はHTMLしか出力できませんが 、この部分は取り替え可能にできています)。Markupとはプレーンテキストを 様々なフォーマットに変換するためのライブラリです。Rdocによってメソッドや クラスに関するドキュメントを生成するとき、コメント部を変換するため に使われます。 ロードマップ RdocでRubyのソースファイルに対
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, usable 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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
RDoc覚え書き
