www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - ddoc for contracts?

reply Lutger <lutger.blijdestijn gmail.com> writes:
Perhaps it has come up before, but what do you think of adding ddoc comments
for contracts? (in/out/invariant)

Contracts are between the code and the user after all, so it makes sense to
document these in certain cases. It might also enable some uber IDE for D
in the future to display contracts if available on right clicking a symbol 
or whatever.
Feb 18 2007
parent Chris Nicholson-Sauls <ibisbasenji gmail.com> writes:
Lutger wrote:
 Perhaps it has come up before, but what do you think of adding ddoc comments
 for contracts? (in/out/invariant)
 
 Contracts are between the code and the user after all, so it makes sense to
 document these in certain cases. It might also enable some uber IDE for D
 in the future to display contracts if available on right clicking a symbol 
 or whatever.

I think it'd be darn nifty. Of course, I also think there needs to be a DDoc switch to change the "protection level" of output. Public-only is fine for most cases, but sometimes I would like to have it output /everything/ for my own quick-referance purposes. -- Chris Nicholson-Sauls
Feb 18 2007