Important alert: (current site time 7/15/2013 7:58:56 AM EDT)
 

article

Comment Tokens

Email
Submitted on: 5/19/2005 12:31:13 PM
By: John Phillips  
Level: Beginner
User Rating: By 1 Users
Compatibility: VB.NET
Views: 7325
author picture
(About the author)
 
     Explain Comment Tokens in the VB.NET IDE

 
 
Terms of Agreement:   
By using this article, you agree to the following terms...   
  1. You may use this article in your own programs (and may compile it into a program and distribute it in compiled format for languages that allow it) freely and with no charge.
  2. You MAY NOT redistribute this article (for example to a web site) without written permission from the original author. Failure to do so is a violation of copyright laws.   
  3. You may link to this article from another website, but ONLY if it is not wrapped in a frame. 
  4. You will abide by any additional copyright restrictions which the author may have placed in the article or article's description.
				This is just a quick article for those do not know of the helpful Comment Tokens in Visual basic .net and C#

First let me explian what a comment token is: A comment token is a character string that can be used in addition to the pre-defined tokens TODO, HACK, or UNDONE as your personal marker for notes in your code.

such as 'TODO', 'HACK', 'UNDONE'

they are very useful because you can start coding methods and if you need to leave them before they are finished you can add the 'TODO' or 'UNDONE'token and you will have a link back to that piece of code from the task list in the VB IDE.

To Use the Token are simple, you use them just like comments. example below:

VB
' TODO finish adding the math functions

C#
// TODO finish adding the math functions

You can add any type of comment token to your programming enviroment by
1. On the Tools menu, choose Options.
2. Choose Environment, and then choose Task List.
3. In the Comment tokens area, type a Name for your custom token.
4. From the Priority list, choose Normal, Low, or High.
5. Click Add, and then choose OK.

To view your tokens in the code:
1. on the View menu, choose Show Tasks
2. choose Comment
3. You should see the task list appear in the VB IDE.


Other 5 submission(s) by this author

 


Report Bad Submission
Use this form to tell us if this entry should be deleted (i.e contains no code, is a virus, etc.).
This submission should be removed because:

Your Vote

What do you think of this article (in the Beginner category)?
(The article with your highest vote will win this month's coding contest!)
Excellent  Good  Average  Below Average  Poor (See voting log ...)
 

Other User Comments
5/20/2005 12:05:17 PMDoug Burkhalter

Wow. I new about the tokens, just that you had TODO and such (I think I noticed it in something generated by VB.NET), but I had no idea you could make your own, and set priorities...great job!
(If this comment was disrespectful, please report it.)

 

Add Your Feedback
Your feedback will be posted below and an email sent to the author. Please remember that the author was kind enough to share this with you, so any criticisms must be stated politely, or they will be deleted. (For feedback not related to this particular article, please click here instead.)
 

To post feedback, first please login.