<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<br>
<div class="moz-forward-container"><br>
<br>
-------- Doorgestuurd bericht --------
<table class="moz-email-headers-table" border="0" cellpadding="0"
cellspacing="0">
<tbody>
<tr>
<th nowrap="nowrap" valign="BASELINE" align="RIGHT">Onderwerp:
</th>
<td>Re: [erlang-questions] dialyzer output help</td>
</tr>
<tr>
<th nowrap="nowrap" valign="BASELINE" align="RIGHT">Datum: </th>
<td>Mon, 10 Aug 2015 15:08:17 +0200</td>
</tr>
<tr>
<th nowrap="nowrap" valign="BASELINE" align="RIGHT">Van: </th>
<td>Roelof Wobben <a class="moz-txt-link-rfc2396E" href="mailto:r.wobben@home.nl"><r.wobben@home.nl></a></td>
</tr>
<tr>
<th nowrap="nowrap" valign="BASELINE" align="RIGHT">Aan: </th>
<td>Loïc Hoguin <a class="moz-txt-link-rfc2396E" href="mailto:essen@ninenines.eu"><essen@ninenines.eu></a></td>
</tr>
</tbody>
</table>
<br>
<br>
<pre>Op 10-8-2015 om 15:06 schreef Loïc Hoguin:
> On 08/10/2015 03:04 PM, Roelof Wobben wrote:
>> Op 10-8-2015 om 14:56 schreef Loïc Hoguin:
>>> On 08/10/2015 02:51 PM, Garrett Smith wrote:
>>>> On Mon, Aug 10, 2015 at 7:47 AM, Loïc Hoguin <a class="moz-txt-link-rfc2396E" href="mailto:essen@ninenines.eu"><essen@ninenines.eu></a>
>>>> wrote:
>>>>> Separate the documentation from the code
>>>>
>>>> For documenting modules along the lines of erlang.org's reference
>>>> material [1] what do you do?
>>>>
>>>> [1] E.g. <a class="moz-txt-link-freetext" href="http://erlang.org/doc/man/lists.html">http://erlang.org/doc/man/lists.html</a>
>>>
>>> This is what *they* do:
>>>
>>> <a class="moz-txt-link-freetext" href="https://github.com/erlang/otp/blob/maint/lib/stdlib/doc/src/lists.xml">https://github.com/erlang/otp/blob/maint/lib/stdlib/doc/src/lists.xml</a>
>>>
>>> What I do is similar, except using Asciidoc:
>>>
>>> <a class="moz-txt-link-freetext" href="https://github.com/ninenines/gun/blob/master/doc/src/manual/gun.asciidoc">https://github.com/ninenines/gun/blob/master/doc/src/manual/gun.asciidoc</a>
>>>
>>>
>>> (Tried a few formats over the years, settled on that one recently,
>>> don't think I'll switch again. :-)
>>>
>>
>>
>> Thanks,
>>
>> But now I more confused.
>> Im reading the introducing erlang book and there is always stated to
>> document your code.
>>
>> I find this the most difficult part because how do I document something
>> like the area function.
>>
>> Roelof
>
> I think for commenting code, Garretttt's advice was spot on. If you
> make the code readable on its own, mainly through the use of proper
> function and variable names, you don't need to put a comment above it
> to explain how it works.
>
Oke, so no spec file for every function ?
Roelof
</pre>
<br>
</div>
<br>
<br /><br />
<hr style='border:none; color:#909090; background-color:#B0B0B0; height: 1px; width: 99%;' />
<table style='border-collapse:collapse;border:none;'>
<tr>
<td style='border:none;padding:0px 15px 0px 8px'>
<a href="https://www.avast.com/antivirus">
<img border=0 src="http://static.avast.com/emails/avast-mail-stamp.png" alt="Avast logo" />
</a>
</td>
<td>
<p style='color:#3d4d5a; font-family:"Calibri","Verdana","Arial","Helvetica"; font-size:12pt;'>
Dit e-mailbericht is gecontroleerd op virussen met Avast antivirussoftware.
<br><a href="https://www.avast.com/antivirus">www.avast.com</a>
</p>
</td>
</tr>
</table>
<br />
</body>
</html>