On Tue, Feb 22, 2011 at 8:14 PM, Lukas Renggli <[email protected]> wrote:
> There are 18 other classes in the same hierarchy that follow the exact > same pattern. I am not sure though if it makes sense to duplicate the > comment? > One way is to put a good comment in one class (GoferOperation ?) then put the comment "See GoferOperation" in the 18 other classes. I've seen in Gofer comment that there's twice: | ==commit== | Commit the modified specified packages. | ==commit:== | Commit the modified specified packages with the given commit message. > > Lukas > > On 22 February 2011 20:01, laurent laffont <[email protected]> > wrote: > > Thanks Lukas. Then I propose: > > I'm a private and internal class to Gofer. I'm a command used to call the > > class side initializers on all package code. > > Laurent. > > > > > > On Tue, Feb 22, 2011 at 7:26 PM, Lukas Renggli <[email protected]> > wrote: > >> > >> This is a private and internal class to Gofer. I am tempted to say > >> that it is therefor not supposed to have a comment. The single > >> reference to this class is the method #reinitialize of the public > >> Gofer API which is commented: > >> > >> Gofer>>reinitialize > >> "Calls the class side initializers on all package code." > >> > >> ^ self execute: GoferReinitialize > >> > >> On 22 February 2011 19:01, laurent laffont <[email protected]> > >> wrote: > >> > anyone ? > >> > > >> > On Mon, Feb 21, 2011 at 8:06 PM, laurent laffont > >> > <[email protected]> > >> > wrote: > >> >> > >> >> Today: GoferReinitialize > >> >> > >> >> Comment Of The Day Contest - One Day One Comment > >> >> Rules: > >> >> #1: Each day a not commented class is elected. Each day the best > >> >> comment > >> >> will be integrated with name of the author(s). > >> >> #2: If you cannot comment it, deprecate it. > >> >> Results: http://code.google.com/p/pharo/wiki/CommentOfTheDayContest > >> >> Laurent > >> > > >> > >> > >> > >> -- > >> Lukas Renggli > >> www.lukas-renggli.ch > >> > > > > > > > > -- > Lukas Renggli > www.lukas-renggli.ch > >
