3
Roxygen2を使用してS4クラススロットを適切に文書化する方法？
roxygen（2）を使用してクラスをドキュメント化する場合、タイトルと説明/詳細の指定は、関数、メソッド、データなどの場合と同じように見えます。ただし、スロットと継承は独自の動物です。roxygen2でS4クラスを文書化するための現在または計画中のベストプラクティスは何ですか？ 適当な注意： @slotroxygenの初期の説明でタグの言及を見つけました。 2008年のR-forgeメーリングリストの投稿 は、これが@slot無効であり、roxygenでのサポートがないことを示しているようです。 これはroxygen2に当てはまりますか？前述の投稿では、ユーザーは代わりにLaTeXマークアップを使用して独自の項目別リストを作成することを推奨しています。たとえば、クラスを拡張する新しいS4クラスは、次の"character"ようにコーディングおよびドキュメント化されます。 #' The title for my S4 class that extends \code{"character"} class. #' #' Some details about this class and my plans for it in the body. #' #' \describe{ #' \item{myslot1}{A logical keeping track of something.} #' #' \item{myslot2}{An integer specifying something else.} #' …