|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title></title>
</head>
<body style="font-family: Verdana,Arial; background-color: #ffffee; font-size: 10pt;">
<h3> Linkify - link your source comments</h3>
<p>
<small><strong>Copyright (C) Peter Hauptmann 2006. Redistribution information and disclaimer
below</strong></small></p>
<h4>
How does it work?</h4>
<p>
Linkify is a Visual Studio 2005 add-in that links your source code comments to your bug tracker, development wiki, MSDN, google
or any other site.
</p>
<p>
Instead of inserting an URL, you insert text that starts with a prefix, e.g.:</p>
<pre><span style="color: #129015"> // this code fixes <span style="text-decoration: underline">bugz:666</span> - don't remove!<br /> // for more info, see <span style="text-decoration: underline">msdn:MakeSureDirectoryPathExists</span> and <span style="text-decoration: underline">wiki:ThatUglySaveBug</span></span></pre>
<p>
<small>Note: I've underlined the linkify-text. The plugin doesn't actually underline
it, but it works anyway ;-) </small></p>
To follow the link, set the cursor on the text to link, and click the
"Linkify" button. You can also assign a hotkey to this command.<br />
<br />
<h4>
Why?</h4>
<p>
Why Linkify is bettter than pasting URLs:</p>
<ul>
<li>The source remains more readable</li><li>You can freely configure the prefix and where it links to</li>
<li>If you move your bug tracker to a new URL, just reconfigure the Linkify entry and
you are done</li>
<li>Linkify doesn't only allow URLs - you can also run a program </li>
</ul>
<p>
</p>
<h4>
How to configure</h4>
<p>
Clicking the "Linkify" button while you are not on recognized text opens the configuration
dialog. There you can manage the list of recognized prefixes and associate them
with URLs or other commands. For example, if you have <code><strong>bugz:</strong></code> configured to go to <code>
<strong>http://companyserver/bugtracker/showbug.asp?id=*</strong></code>,
Linkify will replace that star with the text after "bugz:" in your comment, open e.g. <code>
<strong>http://companyserver/bugtracker/showbug.asp?id=666</strong></code>, which hopefully should open your companies bug tracker with the page for bug #666.
</p><h4>
About Code and Updates</h4>
<p>
The Add-in binaries may be used and redistributed freely in unmodified form. The
latest version (including sources) is available from <a href="http://www.codeproject.com">
http://www.codeproject.com</a>. Please treat my code with respect and share
fixes + improvements. Use at your own risk.</p>
<p>
Copyright (C) Peter Hauptmann 2006</p>
<p>
<strong>In legalese:</strong></p>
<p>
Redistribution and use in source and binary form, with or without modification,
are permitted under the following conditions:
</p>
<ul>
<li>Redistribution of source must retain the copyright and the disclaimer </li>
<li>Modifications to the source should be marked clearly to be distinguishable from
the original sources</li>
</ul>
<p>
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</p>
<p>
Enjoy.</p>
</body>
</html>
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
Peter is tired of being called "Mr. Chen", even so certain individuals insist on it. No, he's not chinese.
Peter has seen lots of boxes you youngsters wouldn't even accept as calculators. He is proud of having visited the insides of a 16 Bit Machine.
In his spare time he ponders new ways of turning groceries into biohazards, or tries to coax South American officials to add some stamps to his passport.
Beyond these trivialities Peter works for
Klippel[
^], a small german company that wants to make mankind happier by selling them novel loudspeaker measurement equipment.
Where are you from?[^]
Please, if you are using one of my articles for anything, just leave me a comment. Seeing that this stuff is actually useful to someone is what keeps me posting and updating them.
Should you happen to not like it, tell me, too
Submit an article or tip