[221] Request: Copy documentation comments from base

Hi,

I have a feature request, if there's nothing like it yet:

In a inherited class that already has overridden members, I'd like to
add all documentation comments from the base class, (to get rid of the
compiler warnings :)

It would be great if I could add/update all comments with 1 action from
the inherited class...

Thanks!

Wiebe

5 comments
Comment actions Permalink

Hello Wiebe,

what compiler warnings do you mean? It doesn't seem reasonable to me to issue
a warning if a method
overriding a base method that has a doc comment doesn't provide its own doc
comment...


Regards,
Dmitry Shaporenkov
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"

Hi,

I have a feature request, if there's nothing like it yet:

In a inherited class that already has overridden members, I'd like to
add all documentation comments from the base class, (to get rid of the
compiler warnings :)

It would be great if I could add/update all comments with 1 action
from the inherited class...

Thanks!

Wiebe



0
Comment actions Permalink

You may try GhostDoc . It's my second favorite add-in for Visual Studio, right behind ReSharper ;)

Regards,
Thomas

http://www.roland-weigelt.de/ghostdoc/

Wiebe Tijsma wrote:

Hi,

I have a feature request, if there's nothing like it yet:

In a inherited class that already has overridden members, I'd like to
add all documentation comments from the base class, (to get rid of the
compiler warnings :)

It would be great if I could add/update all comments with 1 action from
the inherited class...

Thanks!

Wiebe

0
Comment actions Permalink

Thanks!...

Thomas Freudenberg wrote:

You may try GhostDoc . It's my second favorite add-in for Visual
Studio, right behind ReSharper ;)

Regards,
Thomas

http://www.roland-weigelt.de/ghostdoc/

Wiebe Tijsma wrote:

>> Hi,
>>
>> I have a feature request, if there's nothing like it yet:
>>
>> In a inherited class that already has overridden members, I'd like to
>> add all documentation comments from the base class, (to get rid of the
>> compiler warnings :)
>>
>> It would be great if I could add/update all comments with 1 action
>> from the inherited class...
>>
>> Thanks!
>>
>> Wiebe

0
Comment actions Permalink

>>> In a inherited class that already has overridden members, I'd like
>>> to add all documentation comments from the base class, (to get rid
>>> of the compiler warnings :)
>>>
>>> It would be great if I could add/update all comments with 1 action
>>> from the inherited class...

In general, comments are poorly maintained. Furthermore, copying documentation
from a base class to its derivative(s) is duplicating that documentation.
Now we have poorly maintained AND duplicated documentation. It would be better
if, in the documentation of the derivative(s), the feature put a reference
to the base class. For example:

class Parent {
    ///
    public override void Do(Task task) { ... }
}

(Not sure if I got the syntax right for the comments.)

Thus there would be only one place to go to maintain the documentation. Furthermore,
after the documentation reference is added, you could add a little detail
about why the base class behavior is being overridden.

I suppose you could have a feature capable of doing documentation both ways;
I just wouldn't ever use the one that duplicates the documentation.

Regards,
Craig


0
Comment actions Permalink

>>> In a inherited class that already has overridden members, I'd like
>>> to add all documentation comments from the base class, (to get rid
>>> of the compiler warnings :)
>>>
>>> It would be great if I could add/update all comments with 1 action
>>> from the inherited class...

In general, comments are poorly maintained. Furthermore, copying documentation
from a base class to its derivative(s) is duplicating that documentation.
Now we have poorly maintained AND duplicated documentation. It would be better
if, in the documentation of the derivative(s), the feature put a reference
to the base class. For example:

class Parent {
    ///
    public override void Do(Task task) { ... }
}

(Not sure if I got the syntax right for the comments.)

Thus there would be only one place to go to maintain the documentation. Furthermore,
after the documentation reference is added, you could add a little detail
about why the base class behavior is being overridden.

I suppose you could have a feature capable of doing documentation both ways;
I just wouldn't ever use the one that duplicates the documentation.

Regards,
Craig


0

Please sign in to leave a comment.