I follow Brad Abrams blog and saw that he posted on a very nicely implemented Visual Studio add-in component that allows hyperlinking within code-comments.
Vance Morrison (the author of the tool) talks about making code more approachable and how he feels this type of add-in supports getting new developers understanding code faster.
Download it from CodePlex here: HyperAddIn
The main features of the HyperAddin are
- Anchors and Hyerlinks in your code comments. Quickly navigate to related parts of your code by simply clicking on a hyperlink in your comments.
- 'GoOut' Navigation. Quickly find the method, class, and top of the file of the method you are currently in. These places are where you should be put interesting comments about the 'big picture' comments about the design of the code.
- Word wrapping in comments. Form nicely justified paragraphs in your comments with one click of the mouse.
- Supports both C#, C++, JScript and VB style comments.
Vance also asks -
If you like the capabilities of HyperAddin and wish that Visual Studio had this feature, you can vote on this here. To vote, click on the 'Sign in to Rate' (and register if necessary), and then click on the number of stars in the rating box that corresponds to the value of this feature. The more people who vote, the more likely this feature is to get into Visual Studio.
I'm in favor of any feature that makes code I have to maintain easier to work with. He has my vote.
Troy.