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

Question

코드에 javadoc 댓글을 추가하고 돌아 오는 XML 문서의 구조를 요약 할 때 속성을 나타내는 가장 좋은 방법은 무엇입니까? 이것에 대한 모범 사례가 있습니까?

내 Javadoc 의견에 대한 나의 일반적인 구조는 다음과 같습니다.

/**
 * ...
 * 
 * @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>
 */