Thread overview | |||||
---|---|---|---|---|---|
|
January 30, 2007 DDoc functionality | ||||
---|---|---|---|---|
| ||||
I created a "final" class, the the final keyword on the documentation generated by DDoc only appears on "protected" members (along the protected keyword". Also, abstract functions don't appear at all! Finally consider this ///Coordinates of the mouse int mousex, mousey; will only document mousex. This one is easily solved using "///ditto", but on bigger variable declarations things change. It would be much better to isolate documentation by seperate declarations, so that if I wanted "mousey" not documented as "coordinates of the mouse" I'd just put another "int". |
January 30, 2007 Re: DDoc functionality | ||||
---|---|---|---|---|
| ||||
Posted in reply to orgoton | orgoton Wrote:
> I created a "final" class, the the final keyword on the documentation generated by DDoc only appears on "protected" members (along the protected keyword".
>
> Also, abstract functions don't appear at all!
>
> Finally consider this
>
> ///Coordinates of the mouse
> int mousex, mousey;
>
> will only document mousex. This one is easily solved using "///ditto", but on bigger variable declarations things change. It would be much better to isolate documentation by seperate declarations, so that if I wanted "mousey" not documented as "coordinates of the mouse" I'd just put another "int".
Allow me to correct myself: abstract methos do appear, I was checking on the wrong file... :$
|
January 31, 2007 Re: DDoc functionality | ||||
---|---|---|---|---|
| ||||
Posted in reply to orgoton | orgoton escribió:
> I created a "final" class, the the final keyword on the documentation generated by DDoc only appears on "protected" members (along the protected keyword".
>
> Also, abstract functions don't appear at all!
>
> Finally consider this
>
> ///Coordinates of the mouse
> int mousex, mousey;
>
> will only document mousex. This one is easily solved using "///ditto", but on bigger variable declarations things change. It would be much better to isolate documentation by seperate declarations, so that if I wanted "mousey" not documented as "coordinates of the mouse" I'd just put another "int".
OT, I think comments such as the one above ("Coordinates of the mouse") are useless given the name of the variables (mousex and mousey), which are self explanatory. I'm not talking about the text of your comment, I'm talking about the "///" comments.
In a "///" you can only write a sentence. I believe a sentence, for documentation purposes, is not enough, so beeing able to document declarations with this kind of comments leads to a bad habit. Of course you can do something like this:
/// comment 1
/// comment 2
but these can be replaced by the well knwon /** comment.
This is just an opinion, not a complaint.
Ary
|
Copyright © 1999-2021 by the D Language Foundation