JavaDoc 주석의 중복 방지

일부 메소드간에 동일한 xml이 사용되는 클래스를 작성하고 있습니다.JavaDoc 주석의 중복 방지

/** 
* Sample Response: 
* <xmp> 
*  <myXML> 
*   <stuff> data </stuff> 
*  </myXML> 
* </xmp> 
*/ 
CommonXML Method1(); 

/** 
* Sample Submission: 
* <xmp> 
*  <myXML> 
*   <stuff> data </stuff> 
*  </myXML> 
* </xmp> 
*/ 
void Method2(CommonXML xml);

내 문서를 작성하려합니다 그래서 만약 XML 변경 차라리 영향을받는 메소드를위한 Javadoc을 모두 수정하지 않고, 수정할 수있는 하나의 자원이있다.

누구든지 이것을 수행하는 방법을 알고 있습니까?

출처

2011-01-14 TERACytE

java-doc을 만들려면 하나의 클래스를 지정할 수 있습니다. 그래도 Google에 필요합니다. :) – Nishant

나는 Javadoc에서 변수 정의를 재사용하고 싶다고 생각한다. 여기서 OP가 XML 문서에 대해 묻는 사실은 그것이 얼마나 일반적인지를 숨 깁니다 - http://stackoverflow.com/questions/7021696/javadoc-reusable-parameter-values 및 http://stackoverflow.com/questions/1036565/is를 참조하십시오. -it-possible-to-re-use-javadoc에서의 param-descriptions –

는 왜 문서를 읽을하지 : 당신이 당신의 XML을 업데이트 할 경우

/** 
* Returns an XML file conforming to the CommonXML schema, available here 
* (link-to-schema). 
**/

그런 다음, 당신은 당신의 스키마를 업데이트?

출처

2011-01-14 20:53:46 JohnnyO

JavaDoc 가이드 라인에 따라 마침표로 문장을 끝내야합니다. –

Noted and Fixed. – JohnnyO

@see을 다른 방법으로 사용하는 것은 어떻습니까?

출처

2011-01-14 20:55:07

나는이 문서의 대상이되는 각각의 방법보다는 (사실은 문서가 시간 낭비라고 생각한다. 실제로는 문서가 시스템의 기능을 문서화하기 위해 테스트를 사용한다.) CommonXML 객체를 문서화하겠다. 유형.

출처

2011-01-14 20:57:12 time4tea

+1은 CommonXML 객체를 문서화하기위한 제안입니다. (거의 사고 설명서로 -1은 시간 낭비입니다. 문서화되지 않은 디버깅 코드는 더 이상 실망하지 않습니다.) 코드가 무엇인지 파악하기위한 테스트 읽기 더 많은 시간을 필요로합니다. 문서는 개발자의 일급 임무입니다!) –

개발자의 90 %가 코드를 읽는 데 쓴다고 생각하기 때문에 "문서화"시간에 코드를 리팩터링하는 것을 선호하므로 정말 이해하기 쉽다. 그러나 나는 사람들이 그런 종류의 것에 대한 견해를 강하게 가지고 있다는 것을 이해합니다! – time4tea

이 주석은 내가 생산하는 제품의 소비자가 사용하기 때문에 코드에 의존하는 것은 내가 해결할 수있는 해결책이 아닙니다. – TERACytE

Javadoc을 사용하여 다른 곳에서 정의 된 사양을 반복해서는 안됩니다. 자세한 내용은을 참조하십시오.

출처

2011-01-15 00:34:31 EJP

Doclava의 include or sample tag을 사용하면됩니다. 이 태그는 샘플 파일을 임의의 파일에서 출력 javadoc html로 복사합니다. @include 태그는 주어진 파일에서 그대로 텍스트를 복사합니다. @sample 태그는 수정 된 일부 텍스트를 주어진 파일에서 복사합니다.

출처

2013-02-13 15:59:48

JavaDoc 주석의 중복 방지

답변

관련 문제