This is good point. we should give more space to class comments. On Dec 27, 2011, at 4:04 PM, Ben Coman wrote:
> > I could not find any previous discussion of this so I'll just throw this out > there... > > I find that I forget to click the "?" button to read the class comments as I > browse around the system. They are "kind of" hidden. Perhaps also I stop > looking because they are often empty. If others do the same then it is a > downward spiral... if it seems no one looks at them then no one values > writing them. (Except for the good work of the COTDC) > > However System Browser opens by default with 16 lines. > Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused > whitespace. > I wonder if the class comment was to appear (in a separate pane) beneath the > class definition then the class definition would be filled out more often. > Bring the class comments to the fore and perhaps they'll be valued more. At > least for me, it will ensure that I don't miss where there are good comments > I can learn from. Also more attention may focus on the poor comments due to > being more exposed. > just a random thought... > cheers, Ben > > [1] Object subclass: #Behavior > uses: TPureBehavior > instanceVariableNames: 'superclass methodDict format' > classVariableNames: 'ObsoleteSubclasses' > poolDictionaries: '' > category: 'Kernel-Classes' > > >
