version(StdDoc)

H. S. Teoh hsteoh at quickfur.ath.cx
Sun Nov 25 05:31:30 UTC 2018


On Sat, Nov 24, 2018 at 10:27:07PM +0000, Adam D. Ruppe via Digitalmars-d-learn wrote:
[...]
> (Though a parsing thing: /// version(linux) void foo(); - is that doc
> on version linux or on void foo or on both? I guess it could only
> apply it in if there are {}... but eh I still don't love it.)

Yeah that's a tricky case.


[...]
> > It's a bad thing to separate the docs from the actual code, because
> > then the two are liable to go out-of-sync with each other.
> 
> that depends on what kind of docs. for api reference, sure, but other
> docs prolly should be separate because they are bigger picture, and
> thus don't naturally fit well in with the code.

That's what module docs are for. Or docs on aggregates as opposed to
docs on individual members.


> But of course, version(D_Ddoc) is the worst of both worlds.

Agreed.


T

-- 
Customer support: the art of getting your clients to pay for your own incompetence.


More information about the Digitalmars-d-learn mailing list