No header files?

Simen Kjaeraas simen.kjaras at gmail.com
Fri Oct 23 16:56:19 PDT 2009


Yigal Chripun <yigal100 at gmail.com> wrote:

> On 22/10/2009 18:52, BCS wrote:
>> I'm cynical enough that I'd bet if D switches to a "smarter lib format"
>> a lot of people would manage to forget the documentation.
>> With the current system, the library must be shipped with, at a minimum,
>> a human readable list of prototypes.
>>
> without proper documentation people will have no way to know how to use  
> such libraries. given that D has DDoc to automate this process I'd say  
> it'll encourage developers to provide proper documentation instead of  
> just saying - go read the headers/source.

Wild ideas to make people document code:

1) Make DDoc generation the default, turn off by command line switch.

2) Issue a warning (or even error) when a public function is uncommented.

--
Simen



More information about the Digitalmars-d mailing list