[Pharo-project] new template for class empty comments for OB

Alexandre Bergel alexandre.bergel at me.com
Mon Apr 25 17:59:16 CEST 2011


I see your point. We need to iterate on what a good template can be.

In general, I believe a lot can be extracted from unit test execution that can serve as a good basis for documentation: public, private methods, collaboration, ...

Alexandre


On 25 Apr 2011, at 03:15, Lukas Renggli wrote:

> Hi Alexandre,
> 
>> But this is not incompatible. The IVs may still be listed,
>> the template can be adjusted for that
> 
> Yes, this is true and the proposed change takes the IVs into account.
> The only problem is that I have to scroll to the bottom in 90% of the
> cases as the variables are a couple of pages below the template text.
> 90% of the time I am looking for information and then something like
> the variable types is at least useful, a two page template is only
> "useful" the few times I actually write a comment.
> 
> Lukas
> 
> -- 
> Lukas Renggli
> www.lukas-renggli.ch
> 

-- 
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel  http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.








More information about the Pharo-project mailing list