<body><div id="__MailbirdStyleContent" style="font-size: 10pt;font-family: Arial;color: #000000;text-align: left" dir="ltr">
Hi all --<div><br></div><div>Done. See preference #enforceItalicEmphasisInComments.</div><div><br></div><div>Best,</div><div>Marcel</div><div class="mb_sig"></div><blockquote class='history_container' type='cite' style='border-left-style:solid;border-width:1px; margin-top:20px; margin-left:0px;padding-left:10px;'>
<p style='color: #AAAAAA; margin-top: 10px;'>Am 02.07.2022 20:00:17 schrieb Eliot Miranda <eliot.miranda@gmail.com>:</p><div style='font-family:Arial,Helvetica,sans-serif'><div dir="ltr"><br></div><div dir="ltr"><br><blockquote type="cite">On May 17, 2022, at 9:52 AM, Benoit St-Jean via Squeak-dev <squeak-dev@lists.squeakfoundation.org> wrote:<br><br></blockquote></div><blockquote type="cite"><div dir="ltr">
<p>Comments are sometimes *necessary*, no matter how clear, concise
and simple the Smalltalk code might look.</p>
</div></blockquote>+1<br><blockquote type="cite"><div dir="ltr"><p>For instance, the code to generate the A328022 OEIS integer
sequence is pretty straightforward and simple in Smalltalk code.
But unless a *comment* tells you what the code is trying to
achieve, you'd have a hard time understanding what's going on... <br></p></div></blockquote>+1<br><blockquote type="cite"><div dir="ltr"><p>
</p>
<p>So I favor comments in *italic* (as they stand out a lot more
than "sentences in between quotes") as sometimes Smalltalk code
cannot tell you the whole story the way a simple comment can do.<br></p></div></blockquote>+1<div><br></div><div>Amen. I agree 100%<br><blockquote type="cite"><div dir="ltr"><p>
</p>
<div class="moz-cite-prefix">On 2022-05-17 05:16, Marcel Taeumel
wrote:<br>
</div>
<blockquote type="cite" cite="mid:Mailbird-e1a6fc3f-32ea-402b-bec6-b50def2d9cb1@hpi.de">
<div id="__MailbirdStyleContent" style="font-size: 10pt;font-family: Arial;color: #000000;text-align: left" dir="ltr"> Hi Chris --
<div><br>
</div>
<div>> <span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">It's </span><i style="font-family: Arial, Helvetica, sans-serif;font-size: 13px">human-speak</i><span style="font-family: Arial,
Helvetica, sans-serif;font-size: 13px">, whereas the
upright code speaks to the computer. </span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px"><br>
</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">Not quite. Anybody can write
something that the computer can understand. Good source
code, however, is something humans can easily understand. In
Smalltalk, good code can almost read like a sentence in
natural language. It's a challenge, but it is often
possible.</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px"><br>
</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">As for comments, bad ones are
possibly full of slang, proverbs, and other stuff that
"human-speak" might reveal. Good comments are kind of
structured and explanatory. Thus, closer to what might
sometimes be almost source code.</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px"><br>
</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">Consequently, putting effort in
making comments strongly distinct from source code is
counterproductive to what we actually want to achieve here.
I think. :-)</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px"><br>
</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">Best,</span></div>
<div><span style="font-family: Arial, Helvetica,
sans-serif;font-size: 13px">Marcel</span></div>
<blockquote class="history_container" type="cite" style="border-left-style: solid;border-width: 1px;margin-top:
20px;margin-left: 0px;padding-left: 10px;min-width: 500px">
<p style="color: #AAAAAA; margin-top: 10px;">Am 17.05.2022
03:31:21 schrieb Chris Muller <a class="moz-txt-link-rfc2396E" href="mailto:asqueaker@gmail.com"><asqueaker@gmail.com></a>:</p>
<div style="font-family:Arial,Helvetica,sans-serif">
<div dir="ltr">
<div class="gmail_quote">
<blockquote class="gmail_quote" style="margin: 0px 0px
0px 0.8ex;border-left: 1px solid
rgb(204,204,204);padding-left: 1ex;min-width: 500px">
<div>
<div id="gmail-m_4132353372006848215divtagdefaultwrapper" style="font-size: 12pt;color: rgb(0,0,0);font-family: Calibri,Helvetica,sans-serif" dir="ltr">
<p><span style="font-size: 12pt">No ultra-strong
opinion here, but in general, comments are an
inherent part of Smalltalk. As code and
comments tell a shared story together, I'm not
convinced by separating both from each other
even more. Italic has a
"virtual", "artificial", or "auxiliary"
connotation to me, as opposed to "normal" or
"real" code.</span></p>
</div>
</div>
</blockquote>
<div>Interesting, this is actually why I use italic for
comments. It's <i>human-speak</i>, whereas the
upright code speaks to the computer. Italics is often
used in writing for referring to external quotations,
which enhance the thing being written about. It seems
like a perfect fit, to me.</div>
</div>
</div>
</div>
</blockquote>
</div>
<br>
<fieldset class="moz-mime-attachment-header"></fieldset>
<pre class="moz-quote-pre" wrap=""></pre>
</blockquote>
<pre class="moz-signature" cols="72">--
-----------------
Benoît St-Jean
Yahoo! Messenger: bstjean
Twitter: @BenLeChialeux
Pinterest: benoitstjean
Instagram: Chef_Benito
IRC: lamneth
GitHub: bstjean
Blogue: endormitoire.wordpress.com
"A standpoint is an intellectual horizon of radius zero". (A. Einstein)</pre>
<span></span><br></div></blockquote></div></div></blockquote>
</div></body>