| English | 释义 | 拼音 |
|---|---|---|
| comment/ˈkɒment/ | 注释 | zhù shì |
A comment does not repair an active formula
- For price 100,
total = price * 10 / 100;calculates 10 even if a comment 注释 says “amount paid after ten percent off”. Editing that explanation does not make the expression calculate 90. - Change the active expression to
price * 90 / 100to calculate the intended payment in this whole-number example. Comments can reveal an intended policy; verify the code implements it.

Identify text that is excluded from code
//starts a comment ending at the line break./*starts a block comment ending at the next*/; block comments do not nest. Delimiters inside string literals are text, so"https://example.com"does not start a comment.- Comment text is not executed as Java statements. Adding a separate explanation leaves the active expression unchanged; placing
//before an active assignment removes that assignment from the compiled code and can change behavior.
Put Javadoc tags on separate lines
- A
/** ... */documentation comment immediately before a declaration can be processed by Javadoc. Its summary explains the operation; block tags such as@paramand@returnstart their own lines after optional whitespace and*. - The complete class below documents a non-negative radius and returns its circle area. The tags describe inputs, outputs and a rejected input; a comment alone does not enforce the precondition, so the method explicitly checks negative radii.
/** Circle-area calculations for finite radii. */
public class AreaDoc {
/**
* Returns the area of a circle for a finite radius.
* @param r the non-negative radius
* @return the area in squared radius units
* @throws IllegalArgumentException if r is negative
*/
public static double area(double r) {
if (r < 0) {
throw new IllegalArgumentException("Negative radius");
}
return Math.PI * r * r;
}
}

当 @param 嵌入在同一行摘要文本之后时,Javadoc 将其识别为块标签。
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
块标签从可选空白和可选前导星号后的新行开始。请使用所示的多行注释。
Explain the decision a reader cannot see
- A useful discount comment might state “payment is 90% of the listed price; this exercise uses whole-number prices”. This explains policy and assumptions, while
// multiply by 90merely repeats an operation. - A summary of a public method is useful even when its body is short: callers need its contract without studying the implementation. Prefer explanations that supply missing context rather than declaring every descriptive comment redundant.
当Java程序运行时,注释是...
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
注释是给人类看的——Java忽略它们。
Java中哪种标记开始单行注释?
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
// 运行至行尾;/* */ 是块注释。
哪种注释风格会被工具转换为API文档?
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
Javadoc /** */ 配合 @param/@return 生成API文档。
在未修改的活动公式旁添加注释可以修复其计算。
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
错误:注释不是语句。注释掉一条语句可能会改变行为,但这改变的是哪些代码处于活动状态。
好的注释解释WHY,而不是重述显而易见的代码内容。
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
注释意图,而非显而易见的内容。
Check documentation against implementation
- Suppose the comment promises that negative radii are rejected, but the guard is deleted. The documentation is now false even though it still generates successfully; test the negative input as well as an ordinary radius.
- When behavior changes, update the implementation, its checks and its documentation together. Generating an API page verifies documentation syntax, not the truth of every claim in it.
/** Returns an area. @param r radius @return area */ does not put the block tags at the required starts of lines. Use the multiline form above, then inspect the generated parameter and return sections. Ordinary explanatory comments are not executable repairs.
有用的注释还是没有用的?
好的注释解释意图,而非显而易见的内容。对每一个进行分类。
Predict a commented-out assignment
- Start with
int x = 1;. With activex = 5;, printing x gives 5; replacing that line with// x = 5;prints 1. Changing which statements are active differs from adding a note beside an unchanged statement. - Review three questions separately: is the active calculation correct, does the comment accurately explain it, and are the Javadoc tags parsed into their intended sections? A successful compile does not answer all three.
Comments explain code to readers. Delimiters can exclude statements, while notes beside active code do not fix calculations. Javadoc block tags begin on separate lines; keep the documented contract consistent with the implementation.
For a price of 100, type the amount paid after a ten percent discount.
难度 1/5 · 今日首次完成可获 100 金币及少量额外奖励
The intended payment is 100−10=90. The misleading comment does not make the original expression calculate 90.
int x = 1; 后跟独立一行上的 // x = 5;。将打印出 x 的什么值?
难度 2/5 · 今日首次完成可获 140 金币及少量额外奖励
对 5 的赋值被单行注释排除;x 保持为 1。