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

Question

我开始为这样的方法编写 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 event)
Método para modificar el valor de un Label 我不希望此行在恢复方法 espec 中显示为标题

如何设置某个或第一行显示为方法的标题描述？另外，我怎样才能放弃显示类的整个包层次结构？

Answer 1

如果您的意思是您希望第一行是“简短”标题，那么您需要以句号/句点“ . ”结束该行。

我观察到 Javadoc 和 Doxygen 在这方面有所不同。Doxygen 在第一个“ . ”或换行处结束标题。Javadoc 需要“ . ”