コードを文書化しているときに、この小さな問題に遭遇しました。以下の最初の例のように見える多くの行を文書化しようとしていますが、常にその行のすべての変数にまったく同じ説明が与えられます。
変数宣言行を複数の行に分割せずに、1 つのドキュメント (コメント?) のみを使用して、各変数をドキュメント化する方法はありますか?
例 1:
private boolean isDamage = true, isOverTime = false, interruptable = false, canBeDispelled = false;
例 2: (私が文書化しようとした方法。)
/** This is a description. */
private boolean isDamage = true, isOverTime = false, interruptable = false, canBeDispelled = false;
次の例は、現在の変数宣言領域の様子です。複数の宣言行を複数の行に分割する必要がある場合、それは長い混乱になるでしょう。
/** The ID of the spell. */
private int id = -1;
/** The name of the spell. */
private String name = null;
private double damageMin = -1.0, damageMax = -1.0;
private double healMin = -1.0, healMax = -1.0;
private int effectTime = 1;
private double costMana = -1.0, costEnergy = -1.0, castTime = -1.0;
private boolean isDamage = true, isOverTime = false, interruptable = false, canBeDispelled = false;
/** Whether the spell is a buff or not. This only applies to buff and debuff spells. */
private boolean isBuff = false;
private int bonusStrength = 0, bonusDexterity = 0, bonusConstitution = 0, bonusIntelligence = 0, bonusWisdom = 0, bonusCharisma = 0;
private double bonusDamage = 0, bonusHealth = 0, bonusResource = 0; // bonusResource allows you to ass bonus energy or mana depending on the player's type.
返信ありがとうございます。
編集：この投稿を見つけて見ました。それは私が求めていることのほとんどですが、その投稿の答えは私が探しているものではありません.