Alan has written a series of great class design and implementation guidelines posts.
Object Design and Implementation
Rule #1: Practice Drawing Make Good Classes
Rule #2: Documation!
Rule #3: Alan’s Class Template (“ACT”)
Rule #4: Never Walk, But Fly!!!
Rule #5: Always evaluate How We Fly!
Rule #6: No Private Variable Shall Have Direct Access to the Class Public Interface
Rule #7 & #8: All about Numbers!!
It is difficult to maintain documentation and keep it in sync with the code as it changes. The best tool I have found for this is Doxygen, but it is still hard to get people to keep it up to date unless it is part of the team development process.
LikeLike