프로젝트에서 우리는 API javadocs를 작성하려고합니다. 문서 세부 사항에서 벗어나 우리는 히스토리 세부 사항을 쓰고 싶다. 예를 들어 특정 이슈 수정을 위해 메소드가 수정 된 경우 해당 메소드에 대한 javadoc 주석과 함께 이슈의 세부 사항을 문서화하려고합니다.생성 된 Javadoc에 표시되는 문서 주석의 일부를 제외하는 방법
/**
* Displays the details for a valid registered customer against the specified <code>Integer customerId</code>.<br>
* Responsible to check the existance of the customer before sending back the information for the "Customer Reference" screen.
*
* @param customerId the customer id to fetch the details for
* @return <code>jsp</code> file name for "Customer Reference" screen along with Customer details
*
* BTS-1947 | custom fields not displayed correctly | 25-10-2016 | Vaibhav
*/
public String displayCustomerInfo(Integer customerId) {
문제는 우리의 javadoc 도구를 사용하여 생성의 javadoc에 부분 BTS-1947 | custom fields not displayed correctly | 25-10-2016 | Vaibhav
를 표시하지 않는 것입니다. 그렇게 할 수 있습니까? 아니면 javadoc을 사용하여 업데이트 기록을 유지 관리하는 더 좋은 방법이 있습니까?
이 주석은 소스 제어 내역에 대해 어떤 가치를 제공합니까? –
같은 방식으로 느껴지지만 관리자가 소스 관리 이력 (이 경우에는 SVN)보다는 코드 자체를보고 다른 개발자가 기록을 알기를 원하므로이 솔루션을 제공하라는 요청을 받았습니다. 히스토리 부분에 대한 일반적인 다중 행 주석 /*...*/을 작성하지만 두 가지 다른 종류의 주석을 작성하는 것은 좋지 않습니다. – VPK
왜 정보를 javadoc 위의 다른 javadoc이 아닌 주석에 두지 않습니까? – walen