两个类的正确 javadoc 注释

Question

现在我必须为我的代码编写一些 cmets。 代码如下：

/**
 * Provide a block grid of customized size and 
 * a block moving back and forth at the center
 * of the block grid.
 * @author ..
 * @version ..
 */
public class BlockGrid {
    .....
}
/**
 * This is to use the input width, height, and pixel to
 * get the actual pixel and place it.
 */
class MyWindow extends JFrame implements Runnable {
    .....(some ints here)
   /** Constructor
     * use to show the graph of the grid with new height,
     * and width depending on new pixel.
     * @param w This is the logical number of blocks in the 
                width direction.
     * @param h This is the logical number of blocks in the 
                height direction.
     * @param p This is the size of each grid square.
     */
    public MyWindow(int w, int h, int p) {
        .....

    }
}

我知道如何为公共类编写 javadoc cmets，但是如果“类”在公共类之后写，如何编写它的 javadoc cmets？这个类不能是公共类。例如，在这里，我为 BlockGrid 和 MyWindow 这两个类编写了两个 javadoc cmets，不知何故，我的 javadoc cmets 只能将公共类 BlockGrid 部分显示为 *.html 文件形式，以便我在执行命令 javadoc BlockGrid 时检查。 java 在我的终端上，但我跟随它的其他类无法显示。 谢谢

Answer 1

默认情况下，javadoc 只包含公共类和受保护类。将-package 或-private 添加到javadoc 命令行以包含第二类的文档。 javadoc cmets 本身不需要更改。