programing

Javadoc: HTML 태그가 없는 줄 바꿈?

nicescript 2022. 10. 30. 11:17
반응형

Javadoc: HTML 태그가 없는 줄 바꿈?

자주 묻는 질문이라 죄송합니다만, 답변을 찾을 수 없습니다.

Eclipse에서는 Javadoc 코멘트의 공백 행이 줄 바꿈(초기 세로 간격 포함)으로 표시됩니다.

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

공백 행을 줄 바꿈으로 해석하도록 Javadoc을 설정할 수 있습니까?

추가 질문: 소스 내 Javadoc 팝업에서 기본 Netbeans 동작(이와 관련)을 덮어쓸 수 있습니까?

내가 말하는 건

원천

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

이클립스 해석

 Paragraph One

 Paragraph Two

Netbeans 해석

 Paragraph One Paragraph Two

그것은 Netbeans와는 아무런 관련이 없다.한 케이스에서는 소스 코드를 보고 다른 케이스에서는 Javadoc의 출력을 보고 있을 것입니다.HTML에서는 줄바꿈이 중요하지 않습니다.출력에는 줄바꿈이 표시되지 않습니다.새 회선을 사용하려면<p>또는<br>.

이것이 OP의 경우에 도움이 될지는 모르겠지만<pre></pre>포맷을 망치지 않도록 주의해 주세요.그래서 이렇게 보일 거예요

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

텍스트 형식으로 새 행을 표시하는 데 가장 가깝습니다.NetBeans 7.1.2를 사용하고 있습니다.이 방법:code format옵션을 선택하면 문서가 다시 포맷되지 않습니다.힌트에 doc을 표시하는 형식은 그대로입니다.

업데이트: Netbeans 8.x 에서는, 코멘트 포맷을 무효로 하는 옵션이 있습니다.

에는 이미 옵션이 있습니다.NetBeans- 버전 8.2에서 테스트 완료 - 코멘트에 새 행을 저장하거나<p>에 태그 붙입니다.Javadoc필요하다면

  • 에서만Tools메뉴, 선택Options
  • 에 가다Editor탭, 그러면Formatting
  • 에서Language메뉴 선택Java, 및 인Category메뉴 선택Comments
  • 체크하다Preserve New Lines[ ] 체크 박스General섹션은 코멘트에서 새 행을 보존하는 경우에 사용합니다.이렇게 하면 태그를 추가하지 않고도 새 행이 유지됩니다.
  • 확인.Generate "<p>" on Blank Lines[ ] 체크 박스Javadocsection을 클릭합니다.

여기에 이미지 설명 입력

HTML은 소스코드에 속하지 않는다는 당신의 의견에 동의합니다.슬프게도, 나는 이 일로 구글을 검색하는데 많은 도움을 받지 못했다.실제로 구현이 매우 쉽습니다.

컴파일하여 사용할 수 있는 커스텀 Doclet은 다음과 같습니다.

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);
    }
}

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은 CSS 스타일이 정의된 방법을 표시합니다.다음과 같이 문단 태그와 관련된 CSS 스타일을 편집할 수 있습니다.

p {
    line-height: 25px;
}

은 의사 입니다.
(슬프게도 생성된 javadoc에만 영향을 미치지만 Netbeans의 소스 내 javadoc 표시에는 영향을 주지 않습니다).

다음을 포함하는 스타일시트를 지정합니다.

div.block {
    white-space: pre;
}

서 무엇을 있는지는 으로 이 (IDE 만이 아니라)을 , doclet에 이 있습니다)을에 Eclipse를 .여기서 삽입할 수 있습니다.<p>빈 줄마다.

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

반응형