javaDoc에서 XML의 속성을 나타내는 가장 좋은 방법은 무엇입니까?

Question

코드에 javaDoc 주석을 추가하고 전달중인 XML 문서의 구조를 요약하면 속성을 나타내는 가장 좋은 방법은 무엇입니까? 이것에 대한 모범 사례가 있습니까? 내 자바 독에 대한 나의 일반적인 구조는 코멘트

은 다음과 같이이다 :

/** 
* ... 
* 
* @return XML document in the form: 
* 
* <pre> 
* &lt;ROOT_ELEMENT&gt; 
* &lt;AN_ELEMENT&gt; 
* &lt;MULTIPLE_ELEMENTS&gt;* 
* &lt;/ROOT_ELEMENT&gt; 
* </pre> 
*/ 

Answer 1

가 확실하지 나는 명확하게 질문을 이해합니다.

내 선호하는 솔루션은 반환 매개 변수의 설명에 스키마 XSD 또는 DTC를 포함시키는 것입니다. 당신의 솔루션은 여러 요소 나 다른 것들을 표현하는 방법에 관한 개인적인 관용구로 이어지고있는 것 같습니다. XSD 또는 DTD와 같은 표준을 사용하면 XML 문서의 구조를 설명하는 방법에 대해 잘 알고 인식 된 언어를 사용할 수 있습니다.

Eclipse를 사용하는 경우 JavaDoc 표현에 대해 작업 저장 아래에 문서 형식을 지정할 수 있습니다. 이렇게하면 >과 <으로 정상적으로 쓰고 이스케이프 처리 된 HTML 코드로 변환됩니다. 결국

Answer 2

, 방금 갔다 :

/** 
* ... 
* 
* @return XML document in the form: 
* 
* <pre> 
* &lt;ROOT_ELEMENT&gt; 
* &lt;AN_ELEMENT attribute1 attribute2&gt; 
* &lt;MULTIPLE_ELEMENTS&gt;* 
* &lt;/ROOT_ELEMENT&gt; 
* </pre> 
*/