私は実際にコメントをどこに行かなければならないのか、どのようなキーワードを使って私が実際にオンラインの例を見つけるように見えるかを知りたがっています。クラスの不変量をJava文書化する方法は？

/** 
* @invariant invariant example 
*/ 
public class Example { 
}

2016-11-08 Moulie415

普遍的な標準はありませんそれを行う方法。 –

数possibilitesが

@Contract注釈

いくつかの例

@Contractあります（ "_、ヌル - >ヌル"） - メソッドはnullを返します2番目の引数がnullの場合

@Contract（ "_、ヌル - >ヌル;！_、ヌル - >ヌル"） - 2番目の引数がnullであり、そうでない場合は -nullでない場合メソッドはnullを返します。

@Contract（ "true - > fail"） - 典型的なassertFalse（）メソッドは、trueが渡された場合に例外をスローします。

詳細はhttps://www.jetbrains.com/help/idea/2016.2/contract-annotations.htmlを参照してください。

IntelliJ IDEAなしで使用できます。 IDEAはこれらの注釈をスマートにサポートしています。指定された不変条件が実際に満たされているかどうかを調べるメソッドコードです。

テキストによる説明

は、この方法では、すべてのケースをカバーしていません。フィールド間のより複雑な依存関係については、英単語を使用して不変式を記述する必要があります。例えば

、マップが以前にこのキーのマッピングを保持していた場合https://docs.oracle.com/javase/7/docs/api/java/util/Map.html#put(K,%20V)

は、古い値が指定した値に置き換えられます。

例外また

、例外が記述不変強制するために使用することができます。上記Map.put方法のために我々は（不変クラスを破る引数）無効な引数の例外

@throwsにUnsupportedOperationException putオペレーションがこのマップでサポートされない場合

@throwsを以下していますClassCastException - 指定されたキーまたは値のクラスがの場合、このマップに格納できない場合

@throws NullPointerException - 指定されたキーまたは値がnullの場合と、このマップがnullキーを許可したり、指定したキーまたは値のいくつかのプロパティは、このマップに格納できない場合

@throwsのはIllegalArgumentException値はありません

出典

2016-11-08 22:27:04

クラスの不変量をJava文書化する方法は？

答えて

@Contract注釈

テキストによる説明

例外また

関連する問題