|
|
ASP.NET Tutorial 3: Commenting & Documenting Code
by Matt on 2009/11/26 at 6:48 pm
Prerequisites: ASP.NET Tutorial 2: Introduction to C# (Structure)
This tutorial introduces code comments – including general comments, intellisense comments, and code regions. Code comments are little notes that you can leave right inside your code to help yourself or other developers that may need to look at your code. Developing good code commenting habits is absolutely vital for every developer. When you’re projects get even remotely complicated, you will run into situations where you won’t be able to remember what on earth you were doing last, or why you did something a certain way to begin with. Furthermore, if anyone ever inherits your code, comments can make the nearly insurmountable task of deciphering it much more palatable. More often than not, however, it will be you deciphering your own code – so save yourself a lot of time later by spending a little up front and writing good comments. Basic code comments come in two varieties: single-line comments, and multi-line comments.
• Posted under Tutorials and tagged with @Complexity: Beginner, ASP.NET, C#, Visual Studio, Visual Web Developer
|
No Comments