[Pharo-users] On Class and Method comments

Nicolai Hess nicolaihess at gmail.com
Tue May 17 03:49:31 EDT 2016


2016-05-17 8:40 GMT+02:00 Peter Uhnák <i.uhnak at gmail.com>:

> As a note, maybe try to avoid inline comments unless formatter is fixed,
> because autoformatting _will_ misplace them.
>

There were some fixes to make this better.

Now, I only know that comments in block closures are placed behind the
block code.

Do you know more examplmes where the formatter still misplaces the comment.




> (Not to mention that imho inline comments in Smalltalk are a result of a
> bad design… if you need an inline comment, maybe turn that into actual
> code).
>
> In any case, there are no guidelines afaik… otherwise we would have
> comments everywhere already. :)
>
> Perhaps one thing regarding class comments: There was a push to use PIllar
> there if you need formatting, but I am not sure what is the current status
> of that.
>
> Peter
>
> On Tue, May 17, 2016 at 12:04 AM, Dimitris Chloupis <kilon.alios at gmail.com
> > wrote:
>
>> I really like to start writing some class and method comments to make
>> Pharo image more beginner friendly. Are there any guidelines when and how
>> to comment classes and methods ? What about inline comments ?
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.pharo.org/pipermail/pharo-users_lists.pharo.org/attachments/20160517/bb996ee6/attachment.html>


More information about the Pharo-users mailing list