Feature Request: Quickfix for Event XML Documentation

In the current release build of R# 4.0, missing XML documentation on public
events are not flagged. Also, there is no quick fix for public events to
create the XML Documentation.

David


8 comments
Comment actions Permalink

If you enable VS2008 code comment files (project properties) then missing comments will be flagged. As to quick generation, several tools are available, one of the most widely used is Ghostdoc.

0
Comment actions Permalink

Brian,

Thanks for the heads-up on GhostDoc. I tried it and though I claim not to understand all it can do, but after a few minutes of playing with it it looks really professional and highly configurable. As I understand, GhostDoc is intended to add comments to method signatures, etc only? Does it have an NDoc type of capability? Reason I ask, is that I think I read somewhere that the author of NDoc basically stopped development and support because of the lacklustre support the development community were giving back by way of helping out in various ways.

From your experience of such things, is NDoc still ok or is there another useful nugget you know about and have used?

0
Comment actions Permalink

Thanks Brian. However I have been using GhostDoc for years (and still do).

I am not sure what you mean by "enable VS2008 ccode comment files" but the
problem that I am facing is one of cleaning up a large number of missing
documentation in a "brownfield" application that I am working on. It has 35
projects, with an average of 20 class files per project. When I compile it,
I am getting several thousand warnings, all around missing XML
documentation.

I am using R# to handle the process of going in and cleaning up the missing
documentation. I have found that R# correctly finds the missing
documentation (and using ALT-PGDN) and makes navigating to them find. What
I do not like is having a green light from R# and still be getting warning
from the compiler that there is missing documentation. In specific R# is
missing flagging public events and public fields.

David

"Brian Strelioff" <BKStrelioff@Hotmail.com> wrote in message
news:28218021.135541216433541690.JavaMail.jive@app4.labs.intellij.net...

If you enable VS2008 code comment files (project properties) then missing
comments will be flagged. As to quick generation, several tools are
available, one of the most widely used is Ghostdoc.


0
Comment actions Permalink

Check out Sandcastle, a NDoc type utility from Microsoft.

0
Comment actions Permalink

I see what you were getting at, thanks for the clarification. I agree it would be nice if RS never flagged a file "green" if the underlying MS compiler would find fault with it, but unless RS directly maps all MS options, settings, ... related to errors this would probably require a full background compile to ensure. I think we are already hearing a lot of complaints about the amount of CPU time RS uses, so I would not place a high priority on this.

But in the particular instances you refer to (public events/fields not being flagged), RS could probably do this without much additional overhead.

0
Comment actions Permalink

Sandcastle? I've sort of heard of about it but nothing more than a whisper. I will look for it. Thanks for the tip.

Edit: I downloaded it and tried running it on the example project they provide. Strewth's Bob! I've never seen such an arcane and verbose build file output. Is that really the way Sandcastle is meant to be? In this age of the modern IDE and UI it disturbs that Microssoft turned it into a dark science. Sigh!

Edited by: Peter Hamilton-Scott on Jul 20, 2008 12:05 PM

0
Comment actions Permalink

Check out DocProject. It adds a new project type to visual studio, which supports a number of help compilers including SandCastle, and exposes them all nicely to you so that you need only add a DocProject project to your solution, set up the settings the way you like, and then add references in that project, pointing at the projects in your solution for which you want to produce documentation, and then DocProject takes over during your build to crank out the documentation. You'll probably want to disable it from being included in your local build configuration by default, enabling it only in your build process, but that out of the way it is a really nice way to integrate the source documentation help compilation process into your IDE experience and build process.

0
Comment actions Permalink

Thanks Jeremy. You are rapidly morphing into my RS and documentation guru! :)

0

Please sign in to leave a comment.