Tag Archives: Readability
How to Write Good Doc Comments for a Class/Method?
Well, software engineers love to jump to the code (minus document) once design is completed. Majority of them do not write the help text around the class or methods. Some of them do write but they do not provide enough information. There are various reasons for the lack of enough comments within a class. Some of them are lack of time, lack of writing/articulation skills etc. Following are some of the questions which would you like to answer as part of comments for method or a class: Functionality: What does the class or the method do? You may want to provide information regarding the business requirement that the component fulfills. …
I found it very helpful. However the differences are not too understandable for me