473,666 Members | 2,334 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Microsoft.Namin g: CA1703

While using VS2008, I have a word that is beging flaged by the static code
analysis tool as a violation of CA1703,
ResourceStrings ShouldBeSpelled Correctly. I have added the word to my
CustomDictionar y.xml file and set it's build action to
"CodeAnalysisDi ctionary". I still get the error.

The word is actually an abbreviation: ECN which means "Engineerin g Change
Notice." In my case, I need to refer to the ECN in the plural, so I have it
written as "ECNs" which is correct according to to Microsoft Manual of Style
V3 which states "form the plural of an acronum by adding an s with no
apostrophe." It further gives the examples of "APIs" and "CPUs" as correct
plural abreviations. Following this rule, "ECNs" is correct, but try as I
might, I cannot get the Visual Studio Static Code Analysis tool to stop
complaining about "ECNs". If I spell it in all uppercase as "ECNS" it's
happy, but with the "s" is lowercase, it complains. Is there a solution
short of using the SuppressMessage attribute?
Jun 27 '08 #1
3 1720
Hello,

I think several rules do apply here:

1. Acronyms should only be capitalized if they consist of two letters.
2. All other acronyms should be spelled in PascalCase.
3. Well-known acronyms should be spelled all uppercase (API, CPU, etc)
4. With a plural, append a lowercase s

I hope I remember them all correctly - I don't have my Framework Design
Guidelines book around.

So... try Ecns.

Kind regards,
Henning Krause

"Joe Monnin" <Jo*******@disc ussions.microso ft.comwrote in message
news:9C******** *************** ***********@mic rosoft.com...
While using VS2008, I have a word that is beging flaged by the static code
analysis tool as a violation of CA1703,
ResourceStrings ShouldBeSpelled Correctly. I have added the word to my
CustomDictionar y.xml file and set it's build action to
"CodeAnalysisDi ctionary". I still get the error.

The word is actually an abbreviation: ECN which means "Engineerin g Change
Notice." In my case, I need to refer to the ECN in the plural, so I have
it
written as "ECNs" which is correct according to to Microsoft Manual of
Style
V3 which states "form the plural of an acronum by adding an s with no
apostrophe." It further gives the examples of "APIs" and "CPUs" as
correct
plural abreviations. Following this rule, "ECNs" is correct, but try as I
might, I cannot get the Visual Studio Static Code Analysis tool to stop
complaining about "ECNs". If I spell it in all uppercase as "ECNS" it's
happy, but with the "s" is lowercase, it complains. Is there a solution
short of using the SuppressMessage attribute?
Jun 27 '08 #2
How do you PascalCase an acronym? Each letter represents the start of a word
so the whole thing would be uppercased, no? In any event, ECN is a well
known acronym in my industry. If ECNs was a variable name, I would have no
problem with your suggestion, but since this is a piece of text displayed to
the user, it should follow the MoS rules and be displayed ECNs. Are you
saying there is no way to to allow this with the CustomDictionar y?

"Henning Krause [MVP - Exchange]" wrote:
Hello,

I think several rules do apply here:

1. Acronyms should only be capitalized if they consist of two letters.
2. All other acronyms should be spelled in PascalCase.
3. Well-known acronyms should be spelled all uppercase (API, CPU, etc)
4. With a plural, append a lowercase s

I hope I remember them all correctly - I don't have my Framework Design
Guidelines book around.

So... try Ecns.

Kind regards,
Henning Krause

"Joe Monnin" <Jo*******@disc ussions.microso ft.comwrote in message
news:9C******** *************** ***********@mic rosoft.com...
While using VS2008, I have a word that is beging flaged by the static code
analysis tool as a violation of CA1703,
ResourceStrings ShouldBeSpelled Correctly. I have added the word to my
CustomDictionar y.xml file and set it's build action to
"CodeAnalysisDi ctionary". I still get the error.

The word is actually an abbreviation: ECN which means "Engineerin g Change
Notice." In my case, I need to refer to the ECN in the plural, so I have
it
written as "ECNs" which is correct according to to Microsoft Manual of
Style
V3 which states "form the plural of an acronum by adding an s with no
apostrophe." It further gives the examples of "APIs" and "CPUs" as
correct
plural abreviations. Following this rule, "ECNs" is correct, but try as I
might, I cannot get the Visual Studio Static Code Analysis tool to stop
complaining about "ECNs". If I spell it in all uppercase as "ECNS" it's
happy, but with the "s" is lowercase, it complains. Is there a solution
short of using the SuppressMessage attribute?

Jun 27 '08 #3
Hi Joe,

I'm not sure about the custom dictionary.

Kind regards,
Henning Krause
"Joe Monnin" <Jo*******@disc ussions.microso ft.comwrote in message
news:9D******** *************** ***********@mic rosoft.com...
How do you PascalCase an acronym? Each letter represents the start of a
word
so the whole thing would be uppercased, no? In any event, ECN is a well
known acronym in my industry. If ECNs was a variable name, I would have
no
problem with your suggestion, but since this is a piece of text displayed
to
the user, it should follow the MoS rules and be displayed ECNs. Are you
saying there is no way to to allow this with the CustomDictionar y?

"Henning Krause [MVP - Exchange]" wrote:
>Hello,

I think several rules do apply here:

1. Acronyms should only be capitalized if they consist of two letters.
2. All other acronyms should be spelled in PascalCase.
3. Well-known acronyms should be spelled all uppercase (API, CPU, etc)
4. With a plural, append a lowercase s

I hope I remember them all correctly - I don't have my Framework Design
Guidelines book around.

So... try Ecns.

Kind regards,
Henning Krause

"Joe Monnin" <Jo*******@disc ussions.microso ft.comwrote in message
news:9C******* *************** ************@mi crosoft.com...
While using VS2008, I have a word that is beging flaged by the static
code
analysis tool as a violation of CA1703,
ResourceStrings ShouldBeSpelled Correctly. I have added the word to my
CustomDictionar y.xml file and set it's build action to
"CodeAnalysisDi ctionary". I still get the error.

The word is actually an abbreviation: ECN which means "Engineerin g
Change
Notice." In my case, I need to refer to the ECN in the plural, so I
have
it
written as "ECNs" which is correct according to to Microsoft Manual of
Style
V3 which states "form the plural of an acronum by adding an s with no
apostrophe." It further gives the examples of "APIs" and "CPUs" as
correct
plural abreviations. Following this rule, "ECNs" is correct, but try
as I
might, I cannot get the Visual Studio Static Code Analysis tool to stop
complaining about "ECNs". If I spell it in all uppercase as "ECNS"
it's
happy, but with the "s" is lowercase, it complains. Is there a
solution
short of using the SuppressMessage attribute?

Jun 27 '08 #4

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

Similar topics

1
1341
by: scsharma | last post by:
Hi, I am looking for microsoft standards for developing web applications using ..net 1.1 and C#. Specifically i am looking for: 1. UI standards 2. Naming Convention 3. Good coding practices. 4. Any demo/sample demonstrating microsoft approach to developing .net web application.
71
7919
by: Lauren Wilson | last post by:
Hello folks, Would love yo get all informed opinions and/or facts on the following: Over the last few weeks I have spent quite a bit of time reviewing all the Access and .NET stuff I could find on Microsoft.com. It's seems harder and harder to find much of anything about Access as a primary development platform. I am getting the uneasy feeling that Microsoft is slowly phasing out Access.
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...
14
3129
by: 42 | last post by:
Hi, Stupid question: I keep bumping into the desire to create classes and properties with the same name and the current favored naming conventions aren't automatically differentiating them... (both are "Pascal Case" with no leading or trailing qualifiers). For example... I'll be modelling something, e.g. a computer, and I'll
3
976
by: Mario Novado | last post by:
Lately I came to know that Microsoft is suggesting to go with underscore for naming convention for variables (Am I right?). Ex: Dim strMyName as String ---> Dim str_MyName as String Any one has any comments. Am I talking some thing does not makes sense. If you have any URL which tells the Microsoft suggested way on coding standard please share with me. Thank you very much.
35
12176
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.
9
7022
by: BillCo | last post by:
I'm coming from a MS Access background and so I'm very used to and comfortable with the hungarian (Leszynski et al) naming conventions. However, I'm getting started into my first SQL Server Database and really want to use the appropriate up to date standard naming convention (ISO compliant). I think I have the general idea from raking though countless conflicting sites and posts, but I'm a bit stuck on what to do regarding pk / fk naming
8
6157
oll3i
by: oll3i | last post by:
it worked but suddenly when i run it and click a button it throws exception ? D:\SR>java Producent queue1 queue2 queue3 queue4 queue1,queue2,queue3,queue4 javax.naming.NoInitialContextException: Cannot instantiate class: org.exolab.jms .jndi.InitialContextFactory at javax.naming.spi.NamingManager.getInitialContext(NamingManager.java:6 57) at javax.naming.InitialContext.getDefaultInitCtx(InitialContext.java:288 )
2
5006
by: CoreyReynolds | last post by:
Hello all, I'm working with Access 2007 and my VB code is getting an error at: DoCmd.TransferSpreadsheet acExport, acSpreadsheetTypeExcel12, _ strSourceName, strFileName, False I'm attempting to insert a query into that method, and I'm getting the error:
0
8443
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
8781
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
8550
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,...
0
7385
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
6192
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
5663
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
4366
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2769
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
1772
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.