2015-05-24 2 views
0

Сейчас я должен написать несколько комментариев для своего кода. код, как:Собственные комментарии javadoc для двух классов

/** 
* 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 для общественного класса, но если для «класса» пишет только после того, как общественный класс, как писать это комментарии JavaDoc? Этот класс не может быть общедоступным. Например, здесь я пишу оба комментария javadoc для этих двух классов, BlockGrid и MyWindow, так или иначе, мои комментарии javadoc могут показывать только часть открытого класса BlockGrid как * .html-форму файлов для меня, когда я выполняю команду javadoc BlockGrid. java на моем терминале, но мои другие классы, которые следуют за ним, не могут показать. Thanks

ответ

0

По умолчанию javadoc включает только общедоступные и защищенные классы. Добавьте -package или -private в командную строку javadoc, чтобы включить документацию для второго класса. Сами комментарии javadoc не нужно менять.

+0

Спасибо, наконец, увидим их – minitl

Смежные вопросы