如何在javadoc块中设置特定的方法标题描述?

时间:2013-10-24 15:08:21

标签: java javadoc

我开始为这样的方法编写javadoc:

/**
     * This is my method's title
     * I DON'T want this line to be shown as title in the resumed method espec
     * Any lines after this are not shown. though ..
     *<pre>
     *
     * {@code
     *  for (int i = 0; i < arr.length; i++) {
     *      Object object = arr[i];
        }
     * }
     * </pre>
     * 
     * 
     * 
     * @param event Evento que por defecto se recibe en un Nodo, en este caso corresponde al click sobre <code>{@link #button1}</code>
     */
    @FXML private void modificarLabel(ActionEvent event) {

在生成的index.html中显示:

  

modificarLabel(javafx.event.ActionEvent事件)
  Métodoparamodificar el valor de un Label我不希望这条线在恢复的方法espec中显示为标题

如何设置某个或第一行作为方法的标题描述?另外,如何丢弃显示类的整个包层次结构?

1 个答案:

答案 0 :(得分:0)

如果您的意思是希望第一行成为“简短”标题,那么您需要使用句号“”完成该行。

我观察到Javadoc和Doxygen在这方面有所不同。 Doxygen在第一个“新行中完成标题。 Javadoc需要“