PHPDoc ile bir fonksiyon değişiklikleri belgelemek için en iyi yolu nedir? Gibi bir şey
@change 2010.20.16 user added feature x
@change 2010.20.26 user added feature y
harika olurdu. Ama bunu zaten eklerseniz, PHPDoc onunla ne yapacaksın ... hayır @change seçenek var varsayıyorum? Veya fonksiyon değişiklikleri belgelemek için daha iyi / daha doğru bir yolu var mı?
Bu sadece kaynak kodu içine gömmek için deneyin bir changelog txt dosyasına SCM günlüğünü dökümü için daha iyi olabilir.
Nedenleri:
Yıpranmışlık - Eğer kıyamet bir kodlama maraton / sürat gitmek zorunda ise gerçekleşmesi muhtemel değişiklik notlar ekleyerek durdurmak eğer herhangi bir iyi kimse olmayacaktır.
Sıradışı - Ben inline belgeleri derinlemesine bununla bir proje gördüğümü hatırlıyorum olamaz. Bazen sözleşmeler aptal düz dışarı, ama bu bir hikmet bakım aşağı kesim olduğunu düşünüyorum.