IT TIP

Javadoc : HTML 태그없이 줄 바꿈?

itqueen 2020. 10. 29. 20:17
반응형

Javadoc : HTML 태그없이 줄 바꿈?


가능한 FAQ 종류의 질문에 대해 죄송합니다.하지만 답을 찾을 수 없습니다.

내가 이클립스를 기억하는 한, Javadoc 주석의 빈 줄이 (소스 내 Javadoc 팝업에서) 줄 바꿈 (추가 세로 간격 포함)으로 표시됩니다.

그러나 Netbeans에서는 그렇지 않습니다.

빈 줄을 줄 바꿈으로 해석하도록 Javadoc을 구성 할 수 있습니까?

추가 질문 : 소스 내 Javadoc 팝업에 대한 기본 Netbeans 동작 (관련)을 재정의 할 수 있습니까?

내가 말하는 것은 :

출처

/**
 * Paragraph One
 *
 * Paragraph Two
 */
 void someMethod() { }

Eclipse 해석

 Paragraph One

 Paragraph Two

Netbeans 해석

 Paragraph One Paragraph Two

Netbeans와는 관련이 없습니다. 한 경우에는 소스 코드를보고 다른 경우에는 Javadoc의 출력을보고 있다고 생각합니다. 뉴 라인은 HTML에서 상당한되지 않습니다 ERGO 출력을 표시하지 않습니다. 개행을 원하면 <p>또는 <br>.


이것이 OP의 경우에 도움이되는지 확실 <pre></pre>하지 않지만 netbean이 내 서식을 엉망으로 만들지 않도록 문서를 둘러 쌉니다. 그래서 그것은

/**
 * <pre>
 * Paragraph One
 *
 * Paragraph Two
 * </pre>
 */

이것은 텍스트 형식으로 새 줄을 표시하는 데 가장 가깝습니다. NetBeans 7.1.2를 사용하고 있습니다. 이 방법으로 code format옵션을 사용 하면 문서를 다시 포맷하지 않습니다. 힌트에 문서를 표시하는 것은 여전히 ​​형식입니다.

업데이트 : Netbeans 8.x에는 형식 주석을 비활성화하는 코드 형식 지정 옵션이 있습니다.


이미 NetBeans버전 8.2 에서 테스트 된 옵션이있어 주석에서 새 줄을 보존하고 필요한 경우 <p>태그를 추가 Javadoc수 있습니다.

  • 단지에서 Tools메뉴 선택Options
  • Editor탭으로 이동 한 다음 Formatting
  • 에서 Language메뉴 선택 Java및에서 Category메뉴 선택Comments
  • 주석에서 새 줄을 유지 Preserve New Lines하려면 General섹션 확인란을 선택 하십시오 . 태그 를 추가하지 않고 새 줄을 유지합니다.<p>
  • 확인 Generate "<p>" on Blank Lines에서 체크 박스를 Javadoc섹션 당신은 또한 추가 할 경우 <p>태그를 .

여기에 이미지 설명 입력


동의합니다. HTML은 소스 코드에 속하지 않습니다. 슬프게도 나는 이것에 대해 인터넷 검색에 많은 도움을 얻지 못했습니다. 실제로 구현하기가 매우 쉽습니다.

Here's the custom Doclet that you can compile and use:

import com.sun.javadoc.*;
import com.sun.tools.doclets.standard.*;

/**
 * Formats text-only comments with HTML.
 */
@SuppressWarnings("restriction")
public final class TextDoclet {
    private static final Pattern NEWLINE_REGEX = Pattern.compile("\\n");
    private static final String BR = "<br/>\n";

    public static boolean start(RootDoc rootDoc) {
        for ( ClassDoc classdoc : rootDoc.classes())
            classdoc.setRawCommentText(formatText(classdoc.getRawCommentText()));

        return Standard.start(rootDoc);     
    }

    private static String formatText(String text) {
        return NEWLINE_REGEX.matcher(text).replaceAll(BR);
    }
}

An example of how to invoke it using javadoc:

javadoc -docletpath ~/project/text-doclet/target/text-doclet-1.0.0-SNAPSHOT.jar -doclet com.myorg.textdoclet.TextDoclet -sourcepath ~/project/myapp/src/main/java -subpackages com.myorg.myapp

JavaDoc displays the way the CSS styles have been defined. You could edit the CSS styles associated with paragraph tags to do this:

p {
    line-height: 25px;
}

This is a pseudo-solution
(which sadly affects only generated javadoc, but does not affect Netbeans' in-source javadoc display).

Specify a stylesheet which contain the following:

div.block {
    white-space: pre;
}

I have no idea what Eclipse is doing here, but if you want this behavior in general (not only an IDE), you may have to create a new Doclet (which may be based on the default HTML doclet) instead, there inserting a <p> at every empty line or such.

참고URL : https://stackoverflow.com/questions/5077382/javadoc-line-breaks-without-html-tags

반응형