473,659 Members | 2,836 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Naming Conventions

Ted

I'm trying to come up with naming conventions for my
company as we move to C#. I'm looking through the Naming
Guidelines section on MSDN, but I'm unable to find a
recommendation for class scope variables.

Working with WinForms, I believe it would be helpful to
have some type of prefix. In Visual Basic we used
m_variableName. But I can't find any suggestions on this.

Any help on this would be great. Thanks,
Ted
Jul 21 '05 #1
5 1884
Hi Ted

Microsoft suggests the following:

Public methods or properties are pascal cased. (mixed case - first letter
upper case)
Private or protected methods are camel cased. (mixed case - first letter
lower case)
Private or protected fields (variables) are camel cased and prefixed with an
underscore.
Variable names do not use Hungarian notation.
Parameters are camel cased.

Public Class TestClass
Private _stringField1 As String
Protected _stringField2 As String

' public fields are not recommended
' use properties instead
Public StringField3 As String

Public Property StringField1() As String
Get
Return _stringField1
End Get
Set(ByVal Value As String)
_stringField1 = Value
End Set
End Property

Public Sub CoolRoutine1(By Val param1 As String)
End Sub

Private Sub coolRoutine2()
End Sub
End Class

There's a MSDN Webcast on .NET Best Pratices that discusses this over a few
slides.

--
Rob Windsor [MVP-VB]
G6 Consulting
Toronto, Canada

"Ted" <an*******@disc ussions.microso ft.com> wrote in message
news:14******** *************** ******@phx.gbl. ..

I'm trying to come up with naming conventions for my
company as we move to C#. I'm looking through the Naming
Guidelines section on MSDN, but I'm unable to find a
recommendation for class scope variables.

Working with WinForms, I believe it would be helpful to
have some type of prefix. In Visual Basic we used
m_variableName. But I can't find any suggestions on this.

Any help on this would be great. Thanks,
Ted

Jul 21 '05 #2
Cor
Hi Rob,

I have checked for it in the VB.resourcekit and there is this what you show
absolute not used in the best practise sample, so you make me curious.

Also because the type of a object is very good to recognise in dotnet it is
advice to add that not in your dataname, so I am very curious.

Can you give me the link to that documentation.

Cor
Hi Ted

Microsoft suggests the following:

Public methods or properties are pascal cased. (mixed case - first letter
upper case)
Private or protected methods are camel cased. (mixed case - first letter
lower case)
Private or protected fields (variables) are camel cased and prefixed with an underscore.
Variable names do not use Hungarian notation.
Parameters are camel cased.

Public Class TestClass
Private _stringField1 As String
Protected _stringField2 As String

' public fields are not recommended
' use properties instead
Public StringField3 As String

Public Property StringField1() As String
Get
Return _stringField1
End Get
Set(ByVal Value As String)
_stringField1 = Value
End Set
End Property

Public Sub CoolRoutine1(By Val param1 As String)
End Sub

Private Sub coolRoutine2()
End Sub
End Class

There's a MSDN Webcast on .NET Best Pratices that discusses this over a few slides.

Jul 21 '05 #3
Ted

Rob,

Can you send me a link where this is suggested?

In the Design Guidelines for Class Library Developers
microsoft is very inconsistent with naming conventions
while suggesting proper naming conventions.

For example, at http://msdn.microsoft.com/library/en-
us/cpgenref/html/cpconpropertyus ageguidelines.a sp?
frame=true

Microsoft lists the example:

[Visual Basic]
Public Class TextBox
Private m_dataSource As String
Private m_dataField As String
Private m_active As Boolean

Public Property DataSource() As String
Get
Return m_dataSource
End Get
Set (...more)

What is the "m_" prefix? If it's for Module, then module
has a different meaning in .net.

The C# example:

public class TextBox
{
string dataSource;
string dataField;
bool active;

public string DataSource
{
get
{
return dataSource;
}
set (...more)

Now for C# they do not use the prefix.

But what if the constructor accepted the dataSource
variable in the C# example, what would the variable name
for the constructor be? ie. localDataSource or
thisDataSource?

Rob, I like your example of prefixing with the underscore
and will probably go with this, but I just can not find
that recommendation on Microsoft's website in the
guidelines section.

Thank you,
Ted
-----Original Message-----
Hi Ted

Microsoft suggests the following:

Public methods or properties are pascal cased. (mixed case - first letterupper case)
Private or protected methods are camel cased. (mixed case - first letterlower case)
Private or protected fields (variables) are camel cased and prefixed with anunderscore.
Variable names do not use Hungarian notation.
Parameters are camel cased.

Public Class TestClass
Private _stringField1 As String
Protected _stringField2 As String

' public fields are not recommended
' use properties instead
Public StringField3 As String

Public Property StringField1() As String
Get
Return _stringField1
End Get
Set(ByVal Value As String)
_stringField1 = Value
End Set
End Property

Public Sub CoolRoutine1(By Val param1 As String)
End Sub

Private Sub coolRoutine2()
End Sub
End Class

There's a MSDN Webcast on .NET Best Pratices that discusses this over a fewslides.

--
Rob Windsor [MVP-VB]
G6 Consulting
Toronto, Canada

"Ted" <an*******@disc ussions.microso ft.com> wrote in messagenews:14******* *************** *******@phx.gbl ...

I'm trying to come up with naming conventions for my
company as we move to C#. I'm looking through the Naming Guidelines section on MSDN, but I'm unable to find a
recommendation for class scope variables.

Working with WinForms, I believe it would be helpful to
have some type of prefix. In Visual Basic we used
m_variableName. But I can't find any suggestions on this.
Any help on this would be great. Thanks,
Ted

.

Jul 21 '05 #4
Hi,
The convention suggested by Rob has been defined in the book "Inside C#" by Tom Archer, Microsoft Press.

The link you mentioned seems to be going along with the conventions listed in the book, and by Rob. Only exception being the private variables, which are prefixed by 'm_'.

So clases have names like: ClassName
Methods: MethodName
Properties: PropertyName
Private Attributes: m_attributeName
Other Attributes: attributeName

Regards,
Jaswinder
Jul 21 '05 #5
Cor
Hi Jaswinder,

I follow this thread also, and it is in my opinion not true what you write.

Rob is giving to stringvalues very clear the name
stringName

In my opinion Name is enough

Cor
Jul 21 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

4
320
by: Cristof Falk | last post by:
I wanted to get a feel. The documentation gives naming conventions for public/protected members. Is this truly widely adopted? And what about using the same conventions for private members and variables? My coding preference is to use this everywhere (banish Hungarian and follow the capitalization rules) but I need to sell it to team members.
7
2471
by: cmiddlebrook | last post by:
Hi there, I keep finding myself getting inconsistent with naming conventions for things like member variables, class names etc and I just want to find something that suits me and stick to it. I am wondering if there are any naming conventions around that are deemed suitable by the general C++ community. I have googled around and I can't find much - mostly long lists of hungarian-like prefixes which is not really what I'm after.
1
6537
by: clintonG | last post by:
Does the use of DTD, XML Schema and similar constructs adopt the use of C# naming conventions? If so how do I make the distinction of how to apply C# conventions with XML elements, attributes and so on? Any referrals to resources that discuss or document XML Naming Conventions? -- <%= Clinton Gallagher, "Twice the Results -- Half the Cost" Architectural & e-Business Consulting -- Software Development NET...
4
7144
by: Mark Broadbent | last post by:
stupid question time again to most of you experts but this is something that continually bothers me. I am trying to get into the habit of naming variables and controls in an assembly as per convensions. The thing is that Ive never really get the full reference to check against. Ive seen a couple of articles, but there always seems to be a bit missing. I also always seem to run into conflicting convensions both in code samples themselves...
3
4341
by: clintonG | last post by:
Does the use of DTD, XML Schema and similar constructs adopt the use of C# naming conventions? If so how do I make the distinction of how to apply C# conventions with XML elements, attributes and so on? Any referrals to resources that discuss or document XML Naming Conventions? -- <%= Clinton Gallagher, "Twice the Results -- Half the Cost" Architectural & e-Business Consulting -- Software Development NET...
5
6159
by: rastaman | last post by:
Hi all, I know of the existence of Object Naming Conventions for Visual Basic 6. Now I'm reading some books about VB .NET, but the names used for the objects are button1, picturebox1, etc. I wonder if I can use the same naming conventions as for VB6 ? If so, what about the names for the new objects in .NET. Kind regards rastaman
4
5441
by: Patrick | last post by:
what are the general naming conventions for vb.net controls. esp txtUserName, lblPassword, btnSubmit What are the prefixes for the controls???? I've tried to search hi and low on the net, but in vain. I'd much appreciate it if someone could guide me with regards to this. All i need are standards for me to follow by my self. Cuz i'm finding it difficult to make my own darn standards.
9
3806
by: kevininstructor | last post by:
Greetings, I am in the process of creating naming conventions for VB.NET controls i.e. CheckBox -> chkShowThisOnStartup ListBoxt -> lstSomeList What I am looking for other developers input for Window.Form controls and what they are using for naming controls.
35
12175
by: Smithers | last post by:
Is it common practise to begin the name of form classes with "frm" (e.g., frmOneForm, frmAnotherForm). Or is that generally considered an outdated convention? If not "frm" what is a common or recommended practise? Thanks.
1
801
by: Philipp Post | last post by:
Marcello, Not a big surprise as naming conventions have a lot to do with personal prefernces. There are a lot of threads in comp.databases and the other database groups. Just do a search for "naming conventions" in the groups. In my oppinion one of the good conventions is presented by Joe Celko in "SQL Programming Style". I would suggest reading it and pick up
0
8427
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
8332
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
8851
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
8746
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
1
8525
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
1
6179
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
4175
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
1
2750
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
1737
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.