PHPDoc 함수 변경 내역 (@change?)

Question

PHPDoc을 사용하여 함수의 변경 사항을 문서화하는 가장 좋은 방법은 무엇입니까? 예 :

@change 2010.20.16 user added feature x 
@change 2010.20.26 user added feature y 

그러나 아무런 @change 옵션이 없다고 가정하십시오. 어쨌든 그것을 추가하면, PHPDoc은 어떻게 할 것입니까? 아니면 함수 변경을 문서화하는 더 좋고/더 정확한 방법이 있습니까?

Answer 1

변경 로그 txt 파일에 SCM 로그를 덤프 한 다음 소스 코드에 포함 시키십시오.

이유 이유 :

1. 실효 - 당신이 운명의 코딩 마라톤/단거리 경주에 갈 필요하면 일어날 가능성이있는 변경 사항을 추가 중지 경우 누구에게 어떤 좋은하지 않습니다.

2. 자유로운 - 인라인 문서의 깊이있는 프로젝트를 본 기억이 없습니다. 때로는 관례가 멍청한 편이지만,이 일에 대한 지혜는 유지 보수를 줄이는 것이라고 생각합니다.