コードのドキュメント化 | RubyMine ドキュメント

コードのドキュメント化 YARD(英語) および RDoc(英語) は、コードをドキュメント化するために複数のライブラリで使用される最も一般的なドキュメント生成ツールです。RubyMine では、クイックドキュメントルックアップを使用して、YARD または RDoc 構文で記述されたドキュメントを表示できます。さらに、RubyMine は、YARD タグで動作する拡張機能を提供します。 欠落している YARD タグを作成する YARD タグの有効性を確認して修正する YARD タグを活用して、コードインサイトを向上させる (たとえば、オブジェクト型の決定、メソッドのパラメーター情報の表示など。) YARD タグの作成と修正 ここでは、いくつかのパラメーターをとるメソッドを文書化する方法を示します。この場合、メソッドは 2 つの引数を取り、これらの値の積を返します。

[mumei-0]

“YARD(英語) および RDoc(英語) は、コードをドキュメント化するために複数のライブラリで使用される最も一般的なドキュメント生成ツールです。”