A method comment should tell - what it is doing, what are the preconditions - then some concerns about the implementation
You can give a try to document methods of fileSystem or SUnit as Katas. Stef On Sat, Feb 10, 2018 at 5:54 AM, Sean P. DeNigris <s...@clipperadams.com> wrote: > Esteban A. Maringolo wrote >> Commenting an accesor is redundant, IMO. > > Typically, yes, and there are other examples. > > > Esteban A. Maringolo wrote >> I think that having a public guideline on how to comment >> methods would be positive for the community > > Interesting idea. Any suggestions? > > > > ----- > Cheers, > Sean > -- > Sent from: http://forum.world.st/Pharo-Smalltalk-Developers-f1294837.html >
