자바 클래스 주석에서 작성자를 어떻게 설정합니까?

Question

자체 개발을 위해 Java 클래스의 작성자를 클래스 주석에 쓰는 것이 일반적입니다.

이 그것은 모든 저자는이 양식에 나열됩니다

* @author Doe, John (john.doe@example.com) 

의 형태로 기록됩니다,이 클래스에서 가장 많은 일을 한 사람이 먼저 나열됩니다.

내 질문 : 어떻게 이러한 요구 사항을 처리합니까? 주석에 저작권을 설정 했습니까? 아니면 소스 저장소를 사용하여이 정보를 추적합니까? 저자 이름과 이메일을 쓰는 가장 좋은 형식은 무엇입니까?

Answer 1

소스 컨트롤에는 클래스에서 누가 무엇을 언제했는지에 대한 가장 정확한 정보가 있습니다. 신뢰할 수있는 유일한 정보 소스입니다 (여러 사용자가 동일한 사용자/암호를 공유하는 경우 제외).

일반적으로 대부분의 시간은 IDE가 클래스를 만들 때 자동으로 삽입되는 @author 태그는 신경 쓰지 않습니다. 원하는대로 사용하고 원하는 형식을 선택하십시오.

누가 더 많은 작업을 수행합니까? 전체 클래스 코드를 작성한 사람 또는 2 주 동안 조사한 후 생산 버그를 수정하기 위해 한 줄의 코드를 변경 한 사람? 그것은 이름과 이메일 대한 목록을 인쇄

* @author <ul><li>John Doe (john.doe@example.com)</li><li>...</li>...</ul> 

:

Answer 2

나는이 형식을 좋아한다. 저는 그 형식으로 이름과 이메일을보고 싶습니다. 읽을 수 있습니다. 형식이 Surname, name 너무 형식적 인 것으로 나타났습니다. 성에 의해 주문하려고하지 않으므로 왜 귀찮게합니까?