문제 번호를 지정하는 Javadocs

내 Java 코드에서 functionaly를 변경하려고하는 문제가 발생했습니다 (예 : # 41241).문제 번호를 지정하는 Javadocs

이 변경을 요청하는 문제 번호를 지정하는 것이 올바른 Javadoc 코멘트일까요?

앞으로 내가 알고있는 바로는 왜 특정 기능이나 라인이 변경/생성 되었습니까?

2012-09-25 Jaanus

IMHO 이것은 티켓팅/버그 추적 시스템에 따라 다릅니다. 보통 ABOOT 문제 AB01-345에 설명 된대로/** 또는 **/** 문제의 # 123 * /'에 대한/** xyz 변경과 같은 주석을 작성해야합니다. * /'Mylyn의 도움으로 트래킹 시스템에서 해당 문제로 바로 이동할 수 있으므로 정말 좋습니다. –

버그 번호를 소스 코드 주석에 넣는 것에주의하십시오. 그것은 소스 제어 시스템을위한 것입니다. 그러한 의견을 추가 한 지 6 개월 정도 지나면 코드가 완전히 무용 해지고 코드가 가려집니다. – MaDa

소스 코드에 발행 번호를 쓰지 않습니다. ISSUE-1234 : 추가 NPE 체크 방법 때문에 여러 문제로 변경됩니다 때처럼 커밋

은 내가 SVN에 문제 번호를 추가하는 데 사용 ... 복잡 얻을 수 있습니다. Eclipse는 유용한 기능인 Team -> Show Annotations을 제공합니다.이 기능은 SVN이 커밋 된 각 행과 변경된 커밋 주석을 보여줍니다. 필자는이 점이 JavaDoc의 의견으로 더 많은 이점을 제공한다고 생각합니다.

출처

2012-09-25 08:32:55 Kai

이것은 갈 길입니다! –

문제 번호를 지정하는 Javadocs

답변

관련 문제