For Programmers: Free Programming Magazines  


Home > Archive > C# > March 2004 > Can't get documentation comment to generate info on thrown exceptions









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author Can't get documentation comment to generate info on thrown exceptions
James

2004-03-31, 11:44 am

Has anyone got the exception tag to generate documentation in Visual
Studio?
The doc. alledges that you can use

<exception cref="member">description</exception>

in the following manner:

/// <summary>A method</summary>
/// <param name="i">A parameter</param>
/// <exception cref="Exception">It's all gone horribly
wrong...</exception>
public void foo(int i) {...

However, the generated documentation (Tools->Build Comment Web
Pages...) doesn't contain any exception data. If you generate the XML
Doc File in the Configuratin Properties it contains exception data,
and NDoc works fine.
We're using Visual Studio 7.1.3088.

James
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2008 codecomments.com