|
|
|
|
|
|
Author Rank:
|
|
Total page views :
2878
|
|
Total downloads :
|
|
|
|
|
|
Similar ArticlesMost ReadTop RatedLatest
|
|
|
|
|
|
|
|
|
|
Commenting and following a uniform naming guidelines in your code is one of good programming practices to make code more useful. I've been programming with Microsoft products for almost 5 years. I don't know about you but I have faced many problems during integration and bug fixes due to developers not following a uniform naming and comments.
In the previous versions of Visual Studio, Microsoft used to suggest Hungarian notations to write code and encourage developers to follow same guidelines to write a unique format code. For example :-
| Variable |
Notation |
| CString |
szString |
| char |
cMyChar |
| char* |
pMyChar |
| long |
lMyVariable |
| LPCSTR |
lpStr |
| int |
nMyNumber |
In latest release of .NET and it's programming languages, Microsoft has changed it's guidelines to write a unique format of code. If you have even programmed in Delphi, you will see some similarities between the new format and Delphi (Pascal) code.
To avoid code conflicts and make your code more useful, following name guidelines is a good programming practice. Ok, here are some of very common guidelines.
Naming Variables, Methods, and Properties.
The name of variables, properties and methods should start with a capital letter and name should speak about the purpose of variable.
| Variable |
.NET Name |
Hungarian Notation |
Description |
| CString |
EmployeeName |
szName |
Name of an employee. |
| int |
AttendanceCounter |
nCounter |
A counter of type long. |
| long |
NumberOfBytes |
lBytes |
A long type variable stores bytes. |
Sometimes we used to use "_" in our definitions. For example, Add_Data(int a, int b). You should define Add_Data as AddData. According to new guidelines, this is not a good programming practice. Why not? Well .. there is nothing wrong with it. It's just not Microsoft standard and you don't necessarily have to follow these guidelines but there are some places where you will see following these guidelines make sense.
Personally, I like Hungarian notations better than this new pascal type notations. But any way, same rules apply on variables too. If you remember in hungarian notation, a boolean variable was defines as beginning with "b".
Dim bFlag as Boolean = TRUE
New guidelines suggest not to Flag and "b".
Dim IsFileFound as Boolean = true
You can browse MSDN for more details on new guidelines.
Naming Components and Assemblies.
To avoid naming conflicts, following naming guidelines for your library (called assembly in .NET) is a good programming practice. Say you are a company called MindCracker and you are developing an assembly, which provides addition VB.NET database classes. It would be better if you define your assembly name as MindCracker.DatabaseAssembly.ADOSet instead of MyAssembly.Database.ADOSet.
Say your assembly has a method, which reads a table and returns a DataSet. DataSet return_data() should be replaced with DataSet ReturnData().
You should follow a uniform order in names. For example, say you have two tables Employee and Manager and you have two methods. These methods append a record to the table. AppendEmployee and AppendManager is a good programming practice than AppendEmployee and ManagerAppend.
Looping.
Align open and close braces vertically where brace pairs align, such as:
Dim IsFileFound As Boolean = TrueDim i as ineteger For i = 0 To 99 Step+1 Next i
or
Dim i As ineteger For i = 0 To 99 Step+1 Next i
I prefer second method b/c it's easy to understand a block and nested blocks. Same rule apply on other loops too.
If ... Then If ... Then ... Else End If Else ... End If
can be replaced with
If ... Then If ... Then ... Else ... End If Else ... End If
|
|
|
Login
to add your contents and source code to this article
|
|
|
|
|
|
|
|
Mahesh Chand
Mahesh is a software developer with over 13 years of experience building systems for Financial and Banking, Engineering & Architectural, Imaging, Construction, Biological & Pharmaceuticals, Healthcare and Education industries. His expertise is Windows Forms, ASP.NET, Silverlight, WPF, WCF, Visual Studio 2010, SQL Server, and Oracle. If you are looking for a Sharepoint, Windows Forms, ASP.NET, WPF, Silverlight, C#, VB.NET, Oracle, and SQL Server Consultant in Philadelphia area or remote location, drop me a line at MAHESH [AT] C-SHARPCORNER [DOT] COM.
|
|
|
|
|
|
|
|
|
C# Consulting is founded in 2002 by the founders of C# Corner. Unlike a traditional
consulting company, our consultants are well-known experts in .NET and many of them
are MVPs, authors, and trainers. We specialize in Microsoft .NET development and
utilize Agile Development and Extreme Programming practices to provide fast pace
quick turnaround results. Our software development model is a mix of Agile Development,
traditional SDLC, and Waterfall models.
|
|
Click here to learn more about C# Consulting. |
|
|
|
|
|
|
|
Introducing MaxV - one click. infinite control. Hyper-V Hosting from MaximumASP.
Finally – a virtual platform that delivers next-generation Windows Server 2008 Hyper-V virtualization technology from a managed hosting partner you can truly depend on. Visit www.maximumasp.com/max for a FREE 30 day trial. Hurry offer ends soon.
Climb aboard the MaxV platform and take advantage of High Availability, Intelligent Monitoring, Recurrent Backups, and Scalability – with no hassle or hidden fees.
As a managed hosting partner focused solely on Microsoft technologies since 2000, MaximumASP is uniquely qualified to provide the superior support that our business is built on. Unparalleled expertise with Microsoft technologies lead to working directly with Microsoft as first to offer IIS 7 and SQL 2008 betas in a hosted environment; partnering in the Go Live Program for Hyper-V; and product co-launches built on WS 2008 with Hyper-V technology.
|
Dynamic PDF
ceTE software specializes in components for dynamic PDF generation and manipulation. The DynamicPDF™ product line allows you to dynamically generate PDF documents, merge PDF documents and new content to existing PDF documents from within your applications.
|
Go.NET
Build custom interactive diagrams, network, workflow editors, flowcharts, or software design tools. Includes many predefined kinds of nodes, links, and basic shapes. Supports layers, scrolling, zooming, selection, drag-and-drop, clipboard, in-place editing, tooltips, grids, printing, overview window, palette. 100% implemented in C# as a managed .NET Control. Document/View/Tool architecture with many properties&events. Optional automatic layout.
|
Dundas Software
Dundas Chart for .NET is the most advanced .NET charting package available today. With an extremely complete feature set, elegant architecture and easy implementation, Dundas Chart can quickly add advanced Charting functionality to enhance and transform ASP.NET and Windows Forms applications. Whether you are implementing charting into internal projects, or building applications for clients, Dundas Chart offers advanced technology and advanced results to get the most out of data.
|
60 FREE UI Controls from DevExpress
Register for your FREE copy on over 60 free presentation controls from
DevExpress - Absolutely Free-of-Charge without any royalties or distribution
costs. Visit Devexpress.com/60 today. Free controls include advanced lists box, dropdown calendar, rich text edit, spin
edit, tab control and so much more!
DevExpress engineers feature rich presentation controls and reporting tools for WinForms, ASP.NET, WPF, and Silverlight. Our technologies help you build your best, see complex software with greater clarity and deliver compelling business solutions for Windows and the web in the shortest possible time.
|
Clickatell's SMS Gateway
Clickatell's Developer Solutions allow you to SMS enable any website or
application via a range of API's. Learn More about our API connections.
|
Microsoft Visual Studio 2010
Visualize your workspace with new multiple monitor support, powerful Web development, new SharePoint support with tons of templates and Web parts, and more accurate targeting of any version of the .NET Framework. Get set to unleash your creativity.
|
Nevron Chart for .NET 2010.1 Now Available
The leading .NET charting control now features PDF, Flash and Silverlight export, visualization of large datasets and more. Deliver true charting functionality to your BI, Scorecard, Presentation or Scientific apps. Download evaluation now.
|
Developer-Ready ASP.NET 2.0 Web Hosting with 3 MONTHS FREE
Now supporting .NET 3.0 Framework with Windows Workflow Foundation, Windows Communication Foundation (WCF), Windows Presentation Foundation (WPF), windows CardSpace (WCS)! Providing more flexibility for Developers with Web Services Support and a User/Permission Manger. Also supporting MS SQL 2005/2000 with Real-Time Backups, FREE Automated Attach .MDF Tool, FREE SQL Restore and Shrink SQL DB Tools, and SQL
|
|
|
|
|
|
|
|
|
|
|
|
|