XML Documentation


I have just finished a project in beta 2005 of VS.  I have generated the XML Documentation file, which is obviously not very readable.  I have tried using NDoc to compile it, but this does not cope well with generics or inface .NET v2.x.

Are there any programs that will compile this into a nice format

Cheers,

Chris


Answer this question

XML Documentation

  • luis jaramillo

    Nope, as far as i can see, its not there.  So bacially there is not simple way to get a nice looking output from VS 2005.  That is rubbish. Do you have c# express installed or the full visual studio

  • Mike Hillberg - MSFT

    ahh, i would, but project is in on friday :D 

    I have found a style sheet that makes it look a bit better.  I also ammended it to put everything in tables, indented and lists. 

    Chris

  • Shabnam Gupta

    Chris, where have you found the style sheet that copes with the .Net 2.0 XML documentation   I have the same problem.

    Thanks

    Danny

  • Gerhardt

    No it doesn't work with Generics yet, but I do believe there is a plan to update it to do so. I suggest you simply wait a couple of months for an update.

  • Monkan

    Look for an update to NDoc soon, see:

    http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support

  • R.Beaumont

    Hey, thanks for the reply.  I have already tried this update,  it doesnt seem to cope at all with generics.  I suppose i could try and rewrite those sections of code with non-generics in. Have you tried to get this working yourself or anyone else

    Thanks,

    Chris

  • vbkris

    Well, this is what i have found.
    http://www.codeproject.com/soap/XMLDocStylesheet.asp

    I find it really hard to believe that there is not really tool by microsoft for this.

  • Chuck McD

    I heard very useful information that Microsoft will provide alternative solution.  Please look at following URL for more information:

    http://lab.msdn.microsoft.com/productfeedback/viewfeedback.aspx feedbackid=2d65db5c-7bf5-43f3-8496-083aa966c411

     


  • fdefontis

    Well, i just had a chat with the microsoft 3xp3rts

    Yuval [MSFT] (Expert):
    Q: Is there any way to get the xml documentation from a c# .net 2.0 application into a readable format

    A: We don't provide any tools to do it, but there are a couple options.

    You can write your own tool which reads in the XML that the compiler generates and format it into HTML to suit your own needs. Or there are some online tools which do that for you. I think NDoc is one such example, but there are probably others.



    Matt Warren [MSFT] (Expert):
    Q: Are microsoft planning on releasing an xml documention converter as relying on 3rd party application such as NDoc (which doesnt function well with .net 2.0 yet) is not very helpful

    A: We don't have any tool internally to do this. I suspect that NDoc will be updated.


    Obviously very helpful..

  • jjones11

    Build Comment Web Page was removed from Visual Studio 2005. I think it was felt that other products could a better job, see:

    http://blogs.msdn.com/ericgu/archive/2004/06/25/166046.aspx

  • Svante Moren

    Thanks for the Stylesheet, at least that gives me a useful starting point.

    Either I'm missing something or I'm confused.  I don't understand why the 'Build Comment Web Pages' functionality from VS.Net 2003 hasn't been (or isn't going to be) extended for VS.Net 2005  

  • XML Documentation