Click here to Skip to main content
Click here to Skip to main content

Generic exception IntelliSense description in Visual Studio

, 15 Apr 2013
Rate this:
Please Sign up or sign in to vote.
How to define a generic exception definition in Visual Studio.

Introduction

This tip shows how to set up a generic exception comment in the function's header description. Hopefully it will save some time for somebody how is also facing with this issue.

Background

In Visual Studio you can quickly add a function comment by adding /// characters one line above the function name. This description can be parsed by IntelliSense and really helpful during the development.

/// <summary>
/// Opening an Excel workbook
/// </summary>
/// <param name="FileName">Path and name of the excel workbook file</param>
/// <returns>Pointer to the Excel workbook if success otherwise null</returns>
/// <exception cref="App_Exception&lt;App_ExcelHandlerException&gt;"></exception>
public static Workbook OpenExcelWorkbook(...

I was facing with a problem when I tried to define my generic exception in for the "cref=" field. The problem was that the specific characters in the description field needs to be presented with the entity name:

Points of Interest

I wanted to share this quick tip since it was not really obvious for me how to set up correctly.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

M_Tamas
Engineer
Hungary Hungary
No Biography provided

Comments and Discussions

 
-- There are no messages in this forum --
| Advertise | Privacy | Mobile
Web04 | 2.8.140821.2 | Last Updated 15 Apr 2013
Article Copyright 2013 by M_Tamas
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid