145 reputation
1
bio website
location
age
visits member for 2 years, 10 months
seen Feb 12 at 16:30

Sep
5
awarded  Supporter
Aug
29
comment Is it efficient to attach a comment on every function?
@Caleb: Let's take Jave as an example. When I see comments like this one: "Called by all constructors to perform common initialization tasks. Sets all ivars to nil and adds this object to the command hierarchy. Overrides should call this method before doing anything else." This is not very useful at all. I don't know what ivars are? Maybe the code could change faster than the comment because someone forgets changing the comment. Generally it is not a good idea to describe your implementation in Javadoc comments and why should overrides call this function? I would rather call the constructor.
Aug
27
answered Is it efficient to attach a comment on every function?