Да кажем, че оригиналната документация за клас изглежда така:
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*/
Ако дойда и преработя 50% от кода, как да документирам, че съм направил значителен принос?
Кой е най-добрият начин за добавяне на дата? напр. Кога кодът беше последно модифициран, кога направих актуализациите си или кога версията беше актуализирана.
Наясно съм, че всъщност не отговарям на въпроса ви, но се чудя защо изобщо използвате @author.
За проследяване на промените в кода (кой е създал файл? кой го е променил?), използвайте вашата система за контрол на версиите. Все пак за това е :)
Един начин, който съм виждал в компаниите, за които съм работил през годините, е да правя това
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*
* @modifier Rahul Parkar
* @modifiedDate 09/11/2012
*/
Освен това съм ги виждал да използват 2 метода за документиране на промените, единият е да използват нещо като Git, където всеки комит има съобщение за ангажимент, другият е да използват друг Doc таг за документиране на промените.
