2016-11-21 1 views

답변

1

넷빈즈에서 자동으로이 과정을 가지고 가장 가까운는 저장소에 커밋 모든 블루 ( 수정)과 녹색 클래스에 대한 javadoc의 누락 (새로운) 항목을 체크하기 전에 Tools -> Analyze Javadoc를 실행하는 것입니다. 그러나이 프로세스는 클래스에 대한 설명이 이미 존재하는 경우 @author 태그를 추가하지 않으며 기존 태그를 업데이트하지 않습니다. 여기에 the manual입니다.

내가 만진 사람이 터치하여 작성한 각 파일을 자동으로 표시하는 것이 유용 할지는 모르겠지만 그 이유는 이러한 기능을 사용할 수없는 이유 일 수 있습니다. 1 %를 변경 한 수업이 작성자의 변경 자격이 있습니까? 40 %는 어떨까요? 수입품을 개편하면 어떨까요? 등등 ... @lasteditor 또는 복수 @author 또는 @editor 태그를 도입하는 등의 대안 솔루션을 생각해 낼 수는 있지만 여전히 많은 가치가 있다고 확신하지는 않습니다.

git blame (Team -> Show Annotations), git log 등은 작성자와 편집자를 추적하는 작업에 더 적합합니다.

하나의 대안 솔루션은, 적어도 메이븐 프로젝트, Javadoc pluginjavadoc:fix 목적이 될 수 있지만, 각 클래스의 javadoc는 그 이상 공상 @author 태그와 아무것도 있는지 확인합니다 :

<plugin> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <groupId>org.apache.maven.plugins</groupId> 
    <version>2.10.3</version> 
    <configuration> 
     <fixTags>author</fixTags> 
     <force>true</force> 
     <fixFieldComment>false</fixFieldComment> 
     <fixMethodComment>false</fixMethodComment> 
    </configuration> 
</plugin> 
+0

광고의 유용성을 - 그것은 기본적으로 팀에 달려 있습니다. 모든 코드가 항상 SCM에 포함되는 것은 아닙니다. 그리고 파일에 저자를 추가하는 것은 장래의 편집자들에게 유용 할 것입니다. 왜냐하면 이전에, 아마도 파일을 연구하고 세부 사항에 대해 질문 할 수 있기 때문입니다. 정말 "소유권 주장"에 관한 것이 아닙니다. 그것은 아마 당신의 가정 일 것입니다. –

+0

이 기능을 고려할 때 Netbeans 개발자가 생각할 수있는 것, 툴이 '@ author' 태그 업데이트를 보증하기 위해 변경 사항이 충분히 중요하다고 판단 할 수있는 방법 또는 전혀 신경 써야하는지 이 경우에는 간단한 오타 수정으로 인해 업데이트가 발생할 수 있습니다. 개인적으로 필자는 상황에 따라 더 많은 컨텍스트를 제공하는 별도의 readme 또는 changlog 문서가 '@ author' 태그의 창의적인 사용보다 효과적 일 것이라고 생각하지만, 그것은 팀이 결정하기위한 것입니다. –

관련 문제