2016-05-17 18:19 GMT+02:00 Peter Uhnák :
>
> 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.
>
>
> Maybe just comments now? I've added a formatting configuration that
> preserved
yes template looks fine to me, basic classes is a good place to start too.
I will give it a try and see how it goes :)
On Tue, May 17, 2016 at 10:55 PM stepharo wrote:
>
> I really like to start writing some class and method comments to make
> Pharo image more beginner friendly.
>
>
> This would
I really like to start writing some class and method comments to make
Pharo image more beginner friendly.
This would be really coool.
Did you check the class comment template because I wrote it thinking
about this.
What I think would be great is to have great comments for the basic
The problem I have with braking methods to much smaller ones is that it
makes browsing code far more tedious. I think the 10 lines limit is fine
but once you get 5 lines it becomes unnecessarily modular. I think like all
things comments and braking methods should be exercised with some critical
thi
You are absolutely right. Many without comments. Some of which may not
need comments as they are self revealing in what and why. But many which
do need some good comments.
As I read Peter's email. What he was saying is that my intent or why can
be placed in the method comment when broken into
ok guys then it seems all is as expected
I am a fan of inline comments when needed, I am with full agreement with
Jimmie here , braking methods to smaller methods cannot reveal intend, an
inline comment can but thats not big deal i can put everything on the start
so everyone is happy
The problem
> 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.
Maybe just comments now? I've added a formatting configuration that
preserved vertical white space (and I believe also comment posit
On 05/17/2016 01:40 AM, Peter Uhnák wrote:
As a note, maybe try to avoid inline comments unless formatter is
fixed, because autoformatting _will_ misplace them. (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 in
2016-05-17 8:40 GMT+02:00 Peter Uhnák :
> 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 yo
As a note, maybe try to avoid inline comments unless formatter is fixed,
because autoformatting _will_ misplace them. (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 gui
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 ?
11 matches
Mail list logo
