問題タブ [yard]

典型的な OO パターンがあります。1 つの基本抽象クラス (抽象メソッドを定義する) と、これらの抽象メソッドをクラス固有の方法で実装するいくつかのクラスです。

私は、抽象メソッドで一度だけドキュメントを書くことに慣れていて、それは自動的にいくつかの具体的なクラスに伝播します (少なくとも、Javadoc、Scaladoc、Doxygen では次のように機能します)。つまり、同じ説明を繰り返す必要はありません。すべての具体的なクラスで。

しかし、YARD でそのような伝播を行う方法を見つけることができませんでした。たとえば、次のことを試しました。

私が得るもの：

• コードは期待どおりに動作します - つまり、スローAbstractMethodExceptionは抽象クラスで呼び出され、具象クラスでジョブを実行します
• YARD では、AbstractClass抽象的なものとして明確に定義されている、ConcreteClass正常である
• メソッドの説明と戻り値の型が良いAbstractClass
• メソッドはスローAbstractMethodExceptionインと言われていますAbstractClass
• メソッドにはまったく記述がなく、一般的なObject戻り値ConcreteClassの型が にあり、抽象メソッドが基底クラスに存在するという通知は 1 つもありません。

私が期待するもの：

• メソッドの説明と戻り値の型は、ConcreteClassfrom info atに継承 (コピー) されます。AbstractClass
• 理想的には、このメソッドは説明の「継承」または「実装」セクションで指定され、からへConcreteClassの参照リンクがあります。ConcreteClass#do_somethingAbstractMethod#do_something

そうすることは可能ですか？

私は自分のコードを文書化することに興味があります。その大部分は、新しいクラスを作成しないスクリプトです。

YARDドキュメントを読んで、実際にいくつかの YARD ドキュメントを実装しようとすると、定義されたクラス内で YARD タグを宣言しているようです。以下のサンプルコードのように、クラスを作成したり、クラスに新しいメソッドを追加したりするときに、YARD をうまく使用できまし@authorた@example。

私の質問は次のとおりです。

1. クラスを定義せずに YARD タグを使用してコード (特にメソッド) を文書化する方法はありますか?
2. そうでない場合、コードに広範なコメントを入れる以外に、どのような解決策がありますか?

わかりました、Ruby ファイルからメソッドとコメントを抽出し、参照として db に保存する必要があるタスクがあります。

この前に、このコードをスピンオフして同じことを達成することができました

そして、クラス内でこのようなものを使用します

しかし、これにいくつかのコードを書かなければならないという事実は、実際のコメントではありません

YARDで同じことを達成できますか

次のような Ruby コードがあります。

中括弧は文字列の一部である必要があります。この行はコメントアウトされたコードで、そこに残しておきます。さらに、コードを文書化するために YARD を使用しているため、実行するyard docと (自然に) 「本当に」リンクできないという警告がスローされます。

コメントアウトされたコードを無視するように YARD に指示する方法はありますか?

yardいくつかの Ruby クラスのドキュメントを生成するために使用しています。

次のようなメソッドで発生する可能性のあるいくつかのエラーを文書化できます。

これは良い方法ですか？他に良いものはありますか？

クラスに 2 つの attr_writer を作成しました。それらfooを and と呼びましょうbar。

YARD はfooライター ドキュメントをレンダリングしません。手動でリーダーを作成しているためだと思います。

これを回避する方法はありますか？

注：私も試しまし@!attributeたが、同じ結果になりました。