• Home
 · 
• Coding Standards
 · 
• The Use of Comments

The Use of Comments

This article teaches the value of comments in programs, and submissions, as well as why to leave feedback!

Rate The Use of Comments

• 1
• 2
• 3
• 4
• 5

(17(17 Vote))

Introduction
Have you ever downloaded a file on PSC just to realize it has no comments what so ever and the code is some of the worst structured/named code you have ever seen? Well it most likely got a bad vote, and no one liked it...Well this is one of the many reasons Micrsoft has allowed for comments in Visual Basic Projects.

How to start a comment
You start a comment by adding a "'" (Apostrophe) mark(Apostrophe) mark or by using a "Rem:" as the beginning of a comment Line. Notice this only refers to a line, not a paragraph. If you want to make paragraphs you have to use the Line continuation character "_" at the end of each line that you want to seperate. The text then in turn becomes green (or what ever comment code is colored in your options, by default it is green) and you may begin to proceed typing what you want.

When to use them

You should try to use comments whenever possible. Use them for variables, to tell what the variable does. Use it in procedures to say what the purpose is for. Use them whenever.

Feedback

What is the purpose of feed back? To tell the author what you think of the program, any bugs that can be found, what should be removed or added. But why doesn't half the people on PSC ever give some sort of appreciation or comments about a users work. At least try to show that you like the code by Voting. This is a very useful tool, to rate the authors work. If everyone left feedback, then we would have much better submissions, and much better updates. Another thing to note is that Don't ever post an article, which is in turn actually a question that wasn't answered in the forums. All though these forums, aren't very active, still look around your answer maybe found in the millions of lines of code in PSC. Good luck all!
Dragonfire Software

(Note: Fixed HTML)