다중 언어 JavaDocs를 만드는 방법은 무엇입니까?

Question

영어판과 중국어판이있는 일반적인 Java API의 JavaDoc가 있지만 각 버전마다 별도의 소스 코드가 필요합니다. 이 작업을 수행하는 더 편리한 방법이 있습니까?

Answer 1

아니요, 본질적으로이 방법이 없습니다.

떠오르는 유일한 해결 방법은 생성 된 HTML 페이지에 적용됩니다. CSS를 사용하여 언어 간을 전환하는 블록 요소로 JavaDocs를 둘러 쌀 수 있습니다. 고려하지 : 사용자가 언어를 전환 할 수 있도록

/** 
* <div class="en">Documentation in English</div> 
* <div class="nl">Documentatie in Nederlands</div> 
*/ 
public void myFunction() {} 

이후에 JavaDoc을의 CSS를 편집, 예컨대을 :

div.en { display:none; } 
div.nl { display:block; } 

Answer 2

짧은 대답은 NO입니다. 기존의 javadoc 주석과 도구는 이것을 지원하지 않습니다.

javadoc 주석의 여러 번역을 소스 코드에 포함시키기위한 지원을 추가하는 것이 좋지 않을 것이라고 생각합니다. 확장 가능한 솔루션이 아닙니다.

• 새 번역이 추가 될 때마다 소스 코드 파일이 커집니다.
• 다국어 설명은 관리하기가 매우 어려울 수 있습니다.

저는 중국어를 읽거나 쓰지 않는 API 개발자입니다. 영어 javadocs를 업데이트 할 때 중국어 javadoc 주석을 업데이트해야한다고 어떻게 표시합니까? 번역자 중 상당수가 소스 코드 파일을 업데이트해야하고 실수로 실제 코드에 회귀가 발생할 수있는 문제에 대해 우리는 무엇을합니까? 릴리스 관리자는 "금"릴리스 이전에 모든 번역이 완료되었는지 어떻게 확인합니까?

더 나은 (가상의) 솔루션은 javadoc 주석을 버전 데이터베이스로 추출하는 수정 된 javadoc 도구를 사용하는 것입니다. 그런 다음 기본 (예 : 영어) javadoc 주석이 데이터베이스에서 변경 될 때이를 알려주는 도구를 작성하고 기술 작성자/번역자가 javadoc의 중국어, 네덜란드어 등의 번역에서 해당 변경을 수행하도록 요청합니다.