[英]How do Java public/private and static modifiers affect multiple variables declared on one line?
[英]How do I document a single line where multiple variables are declared?
我在記錄代碼時遇到了這個小問題。 我試圖記錄許多看起來像下面第一個例子的行,但它總是給該行上的每個變量提供完全相同的描述。
有沒有辦法記錄每個變量,只使用一個文檔(注釋?),而不將我的變量聲明行分成多行?
例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.
謝謝你的回復!
編輯:我發現並看了一下這篇文章 。 這幾乎就是我所要求的,但那篇文章的答案並不是我想要的。
變量的名稱非常簡單,所以除非你是javadoc文檔,否則沒有必要這樣做。 你沒有這樣做,所以你可以使用一般的措辭
/* Defines spell behaviour */
當另一個開發人員讀取您的代碼時,他將獲得他需要的所有信息以及變量的名稱。 事實上,評論可能根本不需要,因為它幾乎沒有增加任何價值。
如果您確實想使用javadoc文檔,則必須將其拆分為多行。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.