<div dir="ltr">Hi Jaromir,<div><br></div><div>I like to consider the bridge between the code and the user.  By this, and recognizing that methods can have multiple comments, the first method comment could be classified as "special" from the sense that UI's might consume and show it to end users, and would be written under that assumption.  Then, the 2nd comment and beyond comments would be the ones talking to readers of the <i>code</i> (developers).  Also, that first comment (the UI comment) could even, for example, identify the argument types and return type in some standard <i>syntax</i>, that might even be processable -- although that might be handled better with a pragma.</div><div><br></div><div>I do think it's essential for comments to be as terse and polished as they can.  I don't know if it was part of the original spirit of Smalltalk in the 1980's but, at least in the 1990's, my mentors, including Ward Cunningham, taught that long comments are generally detrimental.  Specifically, they can be very helpful.  But long comments on every method causes constant scrolling to be required, increasing the physical and mental effort needed to do development.  They argued that if so much prose is needed just to describe the method, the code should be improved instead.</div><div><br></div><div><i>Documentation</i> is something that can and should be separate, I don't think people should have to come all the way into to the code to find documentation, so I love Tim's idea to support links out to Squeak's Help system from within the methods.  A seamless bridge out to the documentation, so method comments can be talking about mechanics of the method.  Beautiful idea.</div><div><br></div><div>Best,</div><div>  Chris</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Sun, May 29, 2022 at 2:56 PM Jaromir Matas <<a href="mailto:mail@jaromir.net" target="_blank">mail@jaromir.net</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">





<div lang="EN-US">
<div>
<p class="MsoNormal">Hi all,</p>
<p class="MsoNormal">In your experience, what would be a good place to *share* more detailed information about e.g. a method: like why I had to include this line and that check, which situations must be taken into account, alternative approaches, examples,
 references to tests etc etc. Ideally reachable from the image. Would such "notesharing" be welcome or rather confusing or even conterproductive? Often I forget why I did this and that and have to check my notes (if I'm lucky to have made them AND find them).
 I'm aware method comments are definitely not the place; they are meant to be rather terse and polished. Squeak wiki? Squeak Help? They’d have to be linked somehow to the methods, I imagine, to be useful in this regard…</p>
<p class="MsoNormal">Any suggestion welcome :)</p>
<p class="MsoNormal">Best,</p>
<p class="MsoNormal">Jaromir</p>
<p class="MsoNormal"><u></u> <u></u></p>
<p><span lang="CS">--</span></p>
<p><strong><span style="font-family:"Calibri Light",sans-serif;color:rgb(51,51,51);font-weight:normal">Jaromír Matas</span></strong><span style="font-family:"Calibri Light",sans-serif;color:rgb(85,85,85)"><u></u><u></u></span></p>
<p><span style="font-family:"Calibri Light",sans-serif;color:rgb(46,117,182)"><a href="mailto:mail@jaromir.net" target="_blank">mail@jaromir.net</a></span></p>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>

<br>
</blockquote></div>