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

deadalnix via Digitalmars-d digitalmars-d at puremagic.com
Thu Mar 19 02:43:34 PDT 2015


On Wednesday, 18 March 2015 at 19:43:47 UTC, Andrei Alexandrescu 
wrote:
> On 3/18/15 12:28 PM, Jacob Carlborg wrote:
>> On 2015-03-18 19:48, Walter Bright wrote:
>>> I'm fed up with this problem. It is actively hurting us every 
>>> day.
>>>
>>> https://issues.dlang.org/show_bug.cgi?id=14307
>>>
>>> Anyone want to take this on? Shouldn't be particularly 
>>> difficult.
>>
>> I'm not so sure about this. I think there's a big chance that 
>> users will
>> just add an empty documentation comment to silence the error.
>
> That won't pass review. -- Andrei

Here is what will pass review :

class User {
    /**
     * Accessor to get the id of the user.
     *
     * @return : the id of the user
     */
    uint getUserID() { ... }

    /**
     * Accessor to get the name of the user.
     *
     * @return : the name of the user
     */
    string getName() { ... }

// ...
}

This is very popular in "enterprise" code, and there is a reason 
everybody hates it.


More information about the Digitalmars-d mailing list