[B! document] Pockeのブックマーク

Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き！　

RubyやRailsのドキュメントを生成するGem YARDをご存じですか？ドキュメント生成GemではrDocが不動の一番すが、その後ろで猛追しているYARDというGemがあります。今回はこのGemの紹介です。 (02/16 23:30) Ruby 2.1で動作確認しつつリニュアール 🏀 GemのイントロYARDはRubyのドキュメント生成rDocの次世代を期待されているGemです。 Ruby/Railsのコード内にYARDの書式でコメントを書くと、メソッドや引数、戻り値などの解説をうまく表示してくれます。まずGemをインストールします。

Pocke 2015/03/05

リンク

YARD - A Ruby Documentation Tool

YARD Type Parser Here is an experimental version of a parser that converts YARD's formal type syntax into plain old English. This is a good way to test if your type declaration means what you think it does: You can find the code on Github at http://github.com/lsegal/yard-types-parser. Try Some Examples Click the examples to run them. The syntax used in the examples below is not official YARD type

Pocke 2015/02/25

リンク

【YUIDoc】JavaScriptのドキュメントを生成ツールを試してみた。 | DevelopersIO

アジェンダ YUIDocとは? 動作環境についてインストール YUIDocのコメント書き方動作確認 YUIDocとは? JavaScriptのドキュメントを生成ツールです。公式サイト: YUIDoc - Javascript Documentation Tool 動作環境について OS:windows7 node.js インストール Node.jsをインストールしている必要があります。 Node.jsのインストール方法については、弊社野中のこちらの記事をご参考にインストールしてみてください。 YUIDocをインストールする。それではYUIDocパッケージを以下コマンドからインストールしてみます。 npm -g install yuidocjs. イントール完了後、バージョンを確認してみます。ブログ執筆時はバージョン0.3.45でした。 yuidoc -v 0.3.45 YUIDoc