HyperAddin: A Visual Studio Addin which adds hyperlinking in your source code

Created Issue: Partially working on Visual Basic projects.

jackdoh — Thu, 10 Jul 2008 10:01:36 GMT

For some reason on my machine code:ClassName only works on C# projects, on VB Projects it gives a "Could not find symbol xxxx".
code:#segment works fine on both types of project.
I tried stepping thru the source code, and GetList2 always give result with count = 0.

NEW POST: Now if only and were supported.

Qwertie — Sat, 12 Apr 2008 16:25:45 GMT

This add-in is great for 'regular' comments, but if one uses XML doc comments or doxyen comments, one would normally refer to other code elements using syntax like

/// XML style
/// Bla blah blah <see cref="IEnumerable{T}"/> blah blah.
/// <seealso cref="System.String.Length"/>

/// JavaDoc style
/// @see MyMethod()

Would it be hard to make HyperAddin support these links?

Another thing that would be really helpful, although farther from HyperAddin's core purpose, would be if it could convert xml doc comments from that nice natural style that HyperAddin supports:

/// <remarks>
/// Call this function when:
/// * You're lonely
/// * You need a friend
///
/// Note: This method is intended to create genuine friendships, not one-night stands.
/// </remarks>
void Meet(PersonType person)
...

To the amazingly horrible cumbersome monster Microsoft seems to require:

/// <remarks>
/// <para>Call this function when:</para>
/// <list type="bullet">
/// <item><description>You're lonely</item></description>
/// <item><description>You need a friend</item></description>
/// </list>
///
/// <para>Note: This method is intended to create genuine friendships, not one-night
/// stands.</para>
/// <remarks>
void Meet(PersonType person)
...

Yikes!

On second thought, anybody know if I can get a doc generator for the JavaDoc style?

CREATED ISSUE: Snippet comment problem

Raudi — Mon, 31 Mar 2008 08:40:14 GMT

We have noticed a problem when Hyperaddin is enabled in VS2008.
We have some code snippets that have placeholders not only in code but also inside comments when a snippet of this kind is used, the Tab key that inside snippets moves the cursor from a placeholder to the followin does not work correctly inside comments. Where instead it simply writes a tab.

We enclose the snippet on which we noticed this issue first so that you can try it on your system.

UPDATED RELEASE: Release 1 (Aug 31, 2007)

Mon, 04 Feb 2008 19:44:59 GMT

HyperAddin is only useful if you have Visual Studio 2005 (or 2008) installed. To install HyperAddin, you need only copy the contents of the HyperAddin.zip file to your "%HOMEPATH%\My Documents\Visual Studio 2005\Addins directory. A simple procedure for doing this is

* Open on the HyperAddin.zip file by clicking on the link below (and confirming all security dialogs).
* Type Ctrl-A, Ctrl-C to select all files and copy them into the paste buffer.
* Open an explorer window (Start -> Documents) and navigate to "Visual Studio 2005\Addins". If the 'Addins' directory does not exist create it (it should already exist however). For VS 2008 the directory is "Visual Studio 2008\Addins".
* Type Ctrl-V to paste the files.

Launch Visual Studio, and you will notices a 'HyperAddin' Menu entry in the top menu bar. For documentation on use of the addin, simply use the 'HyperAddin Help' menu item.

For Visual Studio 2008 users, the path to the addins directory is Visual Studio 2008\Addins.

Deleting the copied files will uninstall the addin. See the HyperAddin Help for complete details.

-----------------------------------------------------------------

Alternatively, you might consider simply building hyperAddin from the source code, which has the added advantage that you get to immediately try out the hyperlinks in the hyperAddin solution. To do so,
* go to the 'sources' tab for hyperaddin
* open the ZIP and copy the contents to a local folder
* goto the local directory and type 'build.bat' which builds and installs the hyperaddin (doing this before you launch Visual Studio so that VS sees the new addin).
* open Hyperaddin.sln (or HyperAddin_VS2008.sln) in Visual Studio and start browsing (good place to start is _readme.cs)
* Check out the Help in HyperAddin -> HyperAddin Help

NEW POST: Suggested Improvement

dellboy — Sat, 05 Jan 2008 19:06:33 GMT

I loved the HyperAddin. I use it all the time. One feature I wish was there though would be a way of creating a list of the various "bookmarks" at the top of a source file or even just a list of the various bookmarks I've added to source file. A sort of "table of contents" that allows one to quickly and easily navigate to a particular piece of code. It could simply read through a source file finding all the bookmarks and build the commented "table of contents" for that file automatically right at the top of that source file (only needs to happen on demand).

Perhaps even a GUI tool that would also show the links Visual Studio as well (but that's probably a lot of work).

CREATED ISSUE: Format Comment formats beyond selected text.

jschroedl — Wed, 19 Sep 2007 17:38:40 GMT

C++ code in VS2005sp1.

A simple repro case is the follwing code:

// Use lowest 7 bits of the byte.
int b = u30[i] & 0x7f;

Highlight in the first line then trigger FormatComment (Alt+C, Alt+F). The following results:

// Use lowest 7 bits of the byte. int b = u30[i] & 0x7f;

I did not expect the code to be pulled into the comment.

From the Help: "However if a block of text is selected, it will only format lines in that selection"

UPDATED RELEASE: Release 1 (Aug 31, 2007)

Fri, 07 Sep 2007 15:08:25 GMT

HyperAddin is only useful if you have Visual Studio 2005 (or 2008) installed. To install HyperAddin, you need only copy the contents of the HyperAddin.zip file to your "%HOMEPATH%\My Documents\Visual Studio 2005\Addins directory. A simple procedure for doing this is

* Open on the HyperAddin.zip file by clicking on the link below (and confirming all security dialogs).
* Type Ctrl-A, Ctrl-C to select all files and copy them into the paste buffer.
* Open an explorer window (Start -> Documents) and navigate to "Visual Studio 2005\Addins". If the 'Addins' directory does not exist create it (it should already exist however).
* Type Ctrl-V to paste the files.

Launch Visual Studio, and you will notices a 'HyperAddin' Menu entry in the top menu bar. For documentation on use of the addin, simply use the 'HyperAddin Help' menu item.

For Visual Studio 2008 users, the path to the addins directory is Visual Studio 2008\Addins.

Deleting the copied files will uninstall the addin. See the HyperAddin Help for complete details.

-----------------------------------------------------------------

Alternatively, you might consider simply building hyperAddin from the source code, which has the added advantage that you get to immediately try out the hyperlinks in the hyperAddin solution. To do so,
* go to the 'sources' tab for hyperaddin
* open the ZIP and copy the contents to a local folder
* goto the local directory and type 'build.bat' which builds and installs the hyperaddin (doing this before you launch Visual Studio so that VS sees the new addin).
* open Hyperaddin.sln (or HyperAddin_VS2008.sln) in Visual Studio and start browsing (good place to start is _readme.cs)
* Check out the Help in HyperAddin -> HyperAddin Help

UPDATED WIKI: Home

vancem — Fri, 07 Sep 2007 15:01:15 GMT

Project Description
Visual Studio already had the ability to recognize and quickly navigate (with Ctrl LeftClick) to URLs embedded in the comments of the code. This is great, but what is really needed is a way of referring quickly and easily from one part of the code to another part of the code (or to architectural documents checked in with the code). That is exactly what the HyperAddin does: It makes creating and following hyper-links in your code trivial. Now you only have to explain something once in a comment and refer to it many times (got lots of overloaded methods? They should all refer to the 'master' that does the real work).

Hyperlinks in your source code are one of those features that once you have used it, you wonder how you ever got by without it. If you use Visual Studio, you really should try it. Anyone reading your source code (including yourself!) will thank you for it.

Vote for adding to Visual Studio
If you like the features of HyperAddin, vote to get it into the next release of Visual Studio here. To vote click the 'sign in to rate' link and then simply click on the number of stars that indicate its value to you.

Installation
To install, click on the 'Releases' tab above and follow the detailed instructions there. Works on VS2005 and VS2008.

Demo
A reasonable way to demonstrate the power of hyperlinks is to browse the source code of HyperAddin itself. Just download the sources from the 'sources' tab and open the HyperAddin.sln (or HyperAddin_VS2008.sln if you are using VS2008) and open the _Readme.cs file. You can start clicking on links from there.

Documentation
For you convinience I have copied the help.htm file. This is a copy of what you would get on the HyperAddin -> HyperAddin Help menu entry.

UPDATED WIKI: Home

vancem — Fri, 07 Sep 2007 15:00:24 GMT

Project Description
Visual Studio already had the ability to recognize and quickly navigate (with Ctrl LeftClick) to URLs embedded in the comments of the code. This is great, but what is really needed is a way of referring quickly and easily from one part of the code to another part of the code (or to architectural documents checked in with the code). That is exactly what the HyperAddin does: It makes creating and following hyper-links in your code trivial. Now you only have to explain something once in a comment and refer to it many times (got lots of overloaded methods? They should all refer to the 'master' that does the real work).

Hyperlinks in your source code are one of those features that once you have used it, you wonder how you ever got by without it. If you use Visual Studio, you really should try it. Anyone reading your source code (including yourself!) will thank you for it.

Vote for adding to Visual Studio
If you like the features of HyperAddin, vote to get it into the next release of Visual Studio here. To vote click the 'sign in to rate' link and then simply click on the number of stars that indicate its value to you.

Installation
To install, click on the 'Releases' tab above and follow the detailed instructions there.

Demo
A reasonable way to demonstrate the power of hyperlinks is to browse the source code of HyperAddin itself. Just download the sources from the 'sources' tab and open the HyperAddin.sln (or HyperAddin_VS2008.sln if you are using VS2008) and open the _Readme.cs file. You can start clicking on links from there.

Documentation
For you convinience I have copied the help.htm file. This is a copy of what you would get on the HyperAddin -> HyperAddin Help menu entry.

NEW POST: Source code anyone?

vancem — Fri, 07 Sep 2007 14:57:01 GMT

Well, there seems to be interest, so I have uploaded the source code. It is available via the 'sources' tab.

Note that this addin works on VS2005 and VS2008 just fine.

Source code checked in

vancem — Fri, 07 Sep 2007 14:51:23 GMT

First version of the source code. Build by launching solution (ether the HyperAddin.sln (for VS2005) or HyperAddin_VS2008.sln (for VS 2008). Build.bat will also build the addin even without visual studio installed. Building will also run install.bat, which installs the addin in your Visual Studio *\Addins directory.

NEW POST: Source code anyone?

genowaldo — Fri, 07 Sep 2007 04:21:00 GMT

I would like to see how you implemented this. Source code would prove very educational. Thanks in advance for all your work!

UPDATED WIKI: Home

vancem — Wed, 05 Sep 2007 17:08:04 GMT

Project Description
Visual Studio already had the ability to recognize and quickly navigate (with Ctrl LeftClick) to URLs embedded in the comments of the code. This is great, but what is really needed is a way of referring quickly and easily from one part of the code to another part of the code (or to architectural documents checked in with the code). That is exactly what the HyperAddin does: It makes creating and following hyper-links in your code trivial. Now you only have to explain something once in a comment and refer to it many times (got lots of overloaded methods? They should all refer to the 'master' that does the real work).

Hyperlinks in your source code are one of those features that once you have used it, you wonder how you ever got by without it. If you use Visual Studio, you really should try it. Anyone reading your source code (including yourself!) will thank you for it.

Vote for adding to Visual Studio
If you like the features of HyperAddin, vote to get it into the next release of Visual Studio here. To vote click the 'sign in to rate' link and then simply click on the number of stars that indicate its value to you.

Installation
To install, click on the 'Releases' tab above and follow the detailed instructions there.

Documentation
For you convinience I have copied the help.htm file. This is a copy of what you would get on the HyperAddin -> HyperAddin Help menu entry.

NEW POST: Source code anyone?

mwatts42 — Wed, 05 Sep 2007 11:37:24 GMT

I too would like to be able to have access to the source. I would like to get support for VS2008 up and running.

NEW POST: Users with My Documents on a network share

ritchiep — Fri, 31 Aug 2007 18:47:43 GMT

If your network admin has your My Documents folder linked to a network share, HyperAddin (as would any addin) will not load properly when you follow the deployment instructions. (Likely a 80131417 error).

In order to get the add-in to work for the directory the add-in was copied to, you need to grant full trust to that directory. In order to do that you need to be running as an administrator and run the following from a Visual Studio 2005 Command Prompt

caspol -m -ag LocalIntranet_Zone -url "\\servername\sharename\username\Visual Studio 2005\Addins\*" FullTrust -n "Visual Studio 2005 Add-ins" -d "Visual Studio 2005 Add-ins"

Replace servername and sharename with appropriate names. replace username with an appropriate folder name or folder hierarchy.

NEW POST: Source code anyone?

ritchiep — Fri, 31 Aug 2007 15:57:54 GMT

I would love the source code, thanks.

UPDATED WIKI: Home

vancem — Fri, 31 Aug 2007 14:37:53 GMT

UPDATED WIKI: Home

vancem — Fri, 31 Aug 2007 14:37:32 GMT

UPDATED WIKI: Home

vancem — Fri, 31 Aug 2007 14:37:00 GMT

UPDATED WIKI: Home

vancem — Fri, 31 Aug 2007 14:36:38 GMT