RailsTweetこんにちは、こんばんは!よう太です。最近、パン屋めぐりという女子っぽい趣味ができました。今回は、yardとannotateとkramdownを使って、yardドキュメントにテーブル情報を表示させようと思います。オススメのパン屋さん教えてくださいyardとはRailsアプリケーションに含まれるコードの中に、コメントを書くことによってドキュメントを作成することができるgemです。yardによって決められたコメントルールに沿って記述し、yardコマンドを実行すると、ドキュメントを生成することができます。gemのインストールまずは必要なgemをインストールします。installを実行しましょう。'kramdown'yardの基本機能yardコマンドを実行すると、ドキュメントが作成されます。EngineersControllerに以下のようなコメントを記述してみます。これはFactoryGirlの記事を書く際に作成したコントローラーです。endendEngineersControllerを指定して、yardコマンドを実行すると...このようなドキュメントが生成されます!EngineersControllerの中に書かれている@seeや@authorは、yardであらかじめ決められている「タグ」です。server各種設定yardの基本機能を抑えたところで、いよいよ本題に入ります!yardドキュメントにテーブルを表示させるための設定を行いましょう。テーブル作成3STEP♡(1)schemaの出力(2)マークダウンで出力(3)マークダウンの適用(1)schemaの出力annotateは、Railsアプリケーションのschemaやrootを、クラスにコメントとして追加してくれるgemです。以下のように表示されます。下記コマンドを実行すると、annotateの設定ファイルであるlib/tasks/auto_annotate_models.rakeが生成されます。lib/tasks/auto_annotate_models.rakeでは、annotateのオプションを設定することができます。:relation_cakesend(3)マークダウンの適用yardは、デフォルト設定ではマークダウン記法に対応していないため、krramdownをインストールして.yardoptsにオプションを記述する必要があります。下記のようにコメントアウトした改行を入力してください。16新卒のよう太です。»ネオキャリアTECHブログこのブログは、ネオキャリアグループの技術者によるTECHブログです。ネオキャリアグループでは、転職サイトからVRまで、色々なプロダクトを開発しています。~スターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。