ActiveDen: Code Commenting

Code commenting is important to you as a developer to be able to figure out what you’ve done, especially when it’s been a while since you’ve opened your file. It’s even more important for your buyers. Comment your code in a way that makes it quick and easy for a buyer to not only figure out what you’ve built, but also to allow him to effectively modify your file to their needs.

How much commenting do I need?

There’s no exact number of comments, but the general rule is that it needs to be understandable by someone who’s never seen your file before. Remember, you’re selling to a broad range of technical abilities. At least one comment per function is usually enough, but if it’s a complicated concept or there’s a lot going on, you should have more.

Make sure your comments are descriptive. If you have a function that runs when the user clicks the left mouse say:

//This is the function that runs when the user clicks the left mouse

rather than:

//left mouse

Rate this Article (4 Ratings)

Help us improve the wiki Send Your Comments