Enhancement: issue error on all public functions that are missing ddoc sections

Walter Bright via Digitalmars-d digitalmars-d at puremagic.com
Fri Mar 20 16:24:33 PDT 2015


On 3/19/2015 3:27 PM, deadalnix wrote:
> On Thursday, 19 March 2015 at 22:05:51 UTC, Walter Bright wrote:
>> On 3/19/2015 2:40 AM, deadalnix wrote:
>>> And I'm sorry, but if most function require DDoc, your code probably sucks quite
>>> badly and some renaming should be considered.
>>
>> I've never seen any code that self-documented "why".
>
> Indeed, that is why comment are useful. If all your method
> require a why, you probably should consider refactoring instead
> of adding comments all over the place.

I suppose:

     http://dlang.org/phobos/std_math.html#.sin

could be renamed to:

     real returnSineOfArumentInRadians_ReturnNanIfNan_
ReturnNanIfInfinity_InvalidIfArgumentIsNanOrInfinity(real x);



More information about the Digitalmars-d mailing list