■ [ruby] ruremaコマンド(gem install myrurema)が少し便利になりました Rubyの新しいリファレンスマニュアルであるるりまプロジェクトのリファレンスを コマンドラインから引くツール、myruremaをアップデートしました。 候補が複数あったときに、以下のようにどれを表示するか聞いてくるようになりました。 /Users/yhara/proj/myrurema % rurema each_w (1)Enumerable#each_with_index (2)Enumerable#each_with_object (3)Matrix#each_with_index (4)Prime::PseudoPrimeGenerator#each_with_index which one? > エディタから呼び出す場合などキーボード入力したくない場合は、--no-askを付
リファレンスマニュアルの記述方法を検討し、埋め込み方式のドキュメントツールを採用したとします。Rubyで埋め込み方式のドキュメントツールを使うとしたらRDocかYARDになります1。 RDocからYARDへの移行方法につなげたいのでYARDを使う方向で話を進めたいわけですが、その前にRDocとYARDの背景や機能の違いを確認しておきましょう。 RDocの背景 RDocはRuby 1.8.1からRuby本体に標準添付されています。Ruby1.8.1は2003年のクリスマスにリリースされているので、もう7年くらい前になります。Ruby本体や標準添付されているライブラリもRDoc用にドキュメントが書かれていますし、Rubyで標準的なドキュメントツールといえばRDocという存在です。 RDocは2004年くらいまではRuby本体のリポジトリ上で活発に開発されていましたが、それから数年は開発が停滞し
昔から「Rubyはドキュメントが弱い」と言われてきました。「PythonやPHPはあんなにドキュメントが揃っているのに、それに比べてRubyは。。。」というわけです。でも、待ってください。ドキュメントは記述が充実しているだけで十分ですか？簡単に目的のドキュメントにたどりつけますか？ GoogleやBingなどの検索エンジンや、Amazonを筆頭とするECサイトは「探しものを見つけやすくする」ことにどんどん磨きをかけています。なぜ、ドキュメントの検索機能はそれほど進歩しないのでしょうか？ ドキュメントの検索機能が、検索エンジンやECサイトでも使われているような最新の検索パターンを取り入れ、もっとリッチになればプログラミングがもっと楽しくなるはずです。それをRubyのドキュメントで実現しようとしているのがるりまサーチです。 最近、るりまサーチがよりパワーアップしたので、どう変わったかを紹介しま
■ [ruby] ローカルのgemのドキュメントを見る簡単な方法(2010秋) The 3 Step Guide to Slick Local Documentation for all your Ruby Gems 1. $ gem install yard 2. $ yard server --gems 3. http://localhost:8808/ を開く これは便利。特に、普段--no-rdocしててrdocがない場合でも、動的にrdocを生成してくれるところが。 165 http://d.hatena.ne.jp/willnet/20111006/1317877272 49 http://reader.livedoor.com/reader/ 27 http://blog.willnet.in/entry/20111006/1317877272 14 https://www.
(この記事はRuby Advent Calendar jp: 2009の8日目の記事です．前の方はすがまさおさんで，後の方は@Sixeightさんです．) YARD プログラミング言語では，コメントから自動的にドキュメントを生成するツールが大抵用意されていて，RubyにもRDやRDocがあります．RDocは広く使われているので，Rubyistであれば使ったことがあるんじゃないかと思います．そんな中でDataMapperやHamlなど，最近使われるようになってきているのがYARDです．gemが用意されているので $ gem install yardでyardocやyriなどが使えるようになります． yardoc RDocみたいなもので，ソースからドキュメントを生成してくれます．書式は以下のような感じです(スタートガイドから引用)． # Converts the object into tex
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く