共用方式為

Build Comment Web Pages

  • 發行項

In VS2003, there is a feature known as “Build Comment Web Pages” that was designed to take XML doc comments from your code, and create web page documentation.

If you try to find it in VS2003, you won't have much luck, and I thought I'd explain why. We got a fair amount of customer feedback around the disadvantages of the current implementation, and that it wasn't really very useful.

We've therefore elected to pull it from Whidbey. We are exploring whether we can provide a feature that meets our customers needs in the future, but it didn't fit into the schedule.

Luckily, NDoc is available, and it comes much closer to what you want than Build Comment Web Pages did. You can find articles about it here and here and here and here. Oh, and here, too.

Comments

  • Anonymous
    June 25, 2004
    I think you meant that you tried to find in VS2005

  • Anonymous
    June 25, 2004
    The comment has been removed

  • Anonymous
    June 25, 2004
    I don't like the XML comments because you have to name things like argument names/types twice. Once in the actual C# code, and then again in the XML for documentation.

    While XML comments are a small step in the right direction, something more like Knuth's literate programming is needed.

    And of course, comments can be a crutch for writing poor code; clearly written code can minimize the need for a lot of commentary.

  • Anonymous
    June 25, 2004
    Art, this will answer your problem:

    "To use the generated .xml file for use with the IntelliSense feature, let the file name of the .xml file be the same as the assembly you want to support and then make sure the .xml file is in the same directory as the assembly. Thus, when the assembly is referenced in the Visual Studio project, the .xml file is found as well." You can find more info here: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cscomp/html/vcerrDocProcessDocumentationComments.asp

  • Anonymous
    June 25, 2004
    I've got to say that I really liked this feature. Now I agree that the Build Comment Pages function didn't really do anything useful (and I have been using NDoc ever since I found out what it was) BUT, I really like the XML comment system. Especially when you just hit /// and it automatically fills in everything for you about the function other than the description. This stuff really helps to get other people up to speed on a function...anyway, I hope the xml comment features in the editor will remain even without the actual build comment web page function.

  • Anonymous
    June 25, 2004
    http://jaynathan.com/blog/archive/2004/06/25/157.aspx

  • Anonymous
    June 27, 2004
    The comment has been removed

  • Anonymous
    December 18, 2004
    Helpful For MBA Fans.

  • Anonymous
    July 12, 2006
    Documentation Tools
    The essence of documentation can never be under-estimated in software.  Be...

  • Anonymous
    May 29, 2009
    PingBack from http://paidsurveyshub.info/story.php?title=eric-gunnerson-s-c-compendium-build-comment-web-pages

  • Anonymous
    June 13, 2009
    PingBack from http://thestoragebench.info/story.php?id=1513