2013-10-10 1 views
15

java 주석이 수행하는 내용에 대한 설명은 Oracle 설명서를 통해 검색했습니다. @code 이전 질문에서 @code java annotation의 기능

, 나는 그것을 HTML 함께 할 수있는 뭔가가 실현,하지만 난

기본 javadoc에 의해 HTML로 해석됩니다 말을 정확겠습니까 정확히 ... 모르겠어요. .. 그러나 일부 javadoc 텍스트 옆에 @code 주석을 삽입하면 코드로 처리되어야하고 일반적인 방식으로 파싱/렌더링되지 않아야 함을 나타냅니다. 그래서 예를 들면 :

/** 
    *This is how to declare an int variable {@code int var=1;} 
    */ 

그 그것의 사용의 적절한 예겠습니까?

+0

어떤 라이브러리 에서요? –

+2

난 당신이 자바 독에 대한 몇 가지 설명을 찾고 있습니다 생각 : http://stackoverflow.com/questions/541920/multiple-line-code-example-in-javadoc-comment –

+0

[자바를 사용하여 사용자 정의 테스트 러너 만들기 주석] (http://www.singhajit.com/java-custom-annotations/) –

답변

19

{@code }은 Javadoc에 중괄호 안에있는 텍스트가 코드이며 HTML로 취급해서는 안된다고 알려주는 Javadoc 태그입니다. Javadoc는 다른 텍스트와 다르게 코드 블록의 텍스트를 형식화해야합니다. 이것은 질문이나 답변의 서식을 지정할 때 StackOverflow 편집기가 사용하는 "코드 샘플"텍스트와 매우 유사한 개념입니다.

+0

기본적으로 java는 코드를 코드로 취급하지 않습니까? 왜 HTML로 취급할까요? – JMS

+1

JavaDoc은 코드에 대한 HTML 문서를 생성하기 위해 클래스, 생성자 및 메서드에서 사용할 수있는 특별히 형식화 된 주석입니다. 예를 들어 Java API는 완전히 javaDoced이므로 온라인 또는 IDE에서 읽을 수 있습니다 http://docs.oracle.com/javase/7/docs/api/ 자신 만의 방법에 대한 자세한 내용은 다음을 참조하십시오. http : //docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html – dkatzel

1

메소드에 JavaDocs를 추가하려는 경우. 어쩌면 당신은

enter image description here

Javadoc과

당신은 당신이 다른 사람에 대한 @code로 주석을 달 수 있습니다 자바 독과 같은 방법에 대한 코드를 추가하려면 그래서 노란색 물건은 자바 독 여기 무엇인지 모른다 메서드를 사용하여 메서드를 예제로 사용합니다. 우리가하지 않으면 포맷을 제대로하지 못할 수도 있기 때문에 우리는 그것을 사용해야합니다.

그렇지 않은 경우에 일어나는 서식의 변경 사항을 확인하려면 다음 질문을 참조하십시오. @code : Multiple line code example in Javadoc comment

+0

감사합니다 - 예를 들어 설명해 주시겠습니까? – JMS