Rの関数の前提条件と事後条件をチェックして文書化するための慣用的な方法は何ですか?Eiffel
はrequire
とensure
のコンストラクト、またはというブロックで構成されていると考えていますが、ほとんどの言語ではこれらのベークが行われていないため、それらを近似するベストプラクティスが開発されています。Rの関数の前提条件と事後条件をチェックして文書化する慣用方法は何ですか?
前提条件を確認することによって、関数の前提条件を満たさないデータが渡された場合に実行時例外が発生することを意味します。現在、関数の先頭にあるすべての前提条件について、stopifnot
というステートメントがあります。事後条件にも同じことが当てはまりますが、パラメータではなく戻り値に関するものです。
さらに、これらの前提条件と事後条件が何であるかを文書化する標準的な方法がありますか?たとえば、JavaのJavaDocコメントでこれらを綴るのはかなり標準的です。
この点でRのベストプラクティスは何ですか?