[1227] Naming rules support for C# standards

Is there a way I can get the method/property naming rules to respect the C# guidelines regarding casing of acronyms?  For example, IncludeInUI gives an inspection warning.  I can add UI to the abbreviation list, but I cannot find any option to allow capitalised two letter acronyms.

Thanks

Sean

6 comments

Hi.

We don’t have an option to ignore capitalized two letter acronyms. Do you have a lot of such acronyms in your project? (I have two: ‘ID’ ‘VB’ =)

Allowing any two letter acronyms may result in appearance of unwanted names in your project: “ResultOK, UP, DOAnalysis, etc”. So our analysis allows using of ‘generally accepted’ acronyms only.

We have plans to extend acronyms with ability to provide the only one possible spelling for a word (that will suggest you to use ID instead of Id). As you can see this is a more strict analysis. But I think that it a good practice to have all ‘ID’ identifiers in the unified form.

0

Thanks Sergey, I will try working with the abbreviations list and see how that goes.

0

Where is the "abbreviation list" stored? Can it be edited manually? I
couldn't find it...

I have a situation where the abbreviation comes at the beginning of a
parameter name. It's a two letter abbreviation and it's used throughout the
code. For some reason, I guess because it starts with a capital letter, it
doesn't prompt me to add this two letter abbreviation to the abbreviation
list... so I have a lot of underlined code that isn't going to change, and
with no way to disable the underlines without losing all the normal benefits
of this analysis.

Basically, I need to specify specific exceptions. To use your example with
ID... if a parameter is IDs (plural), that should be allowed by our
standards. But ids and Ids should be underlined, and any arbitrary two
letters or capitalized first letter should be underlined.

How do go about this?

Help? I'd like to add our
"Sergey Shkredov" <no_reply@jetbrains.com> wrote in message
news:10519723.70571239341652138.JavaMail.clearspace@app8.labs.intellij.net...
>

Hi.

>

We don’t an option to ignore capitalized two letter acronyms. Do you have
a lot of such acronyms in your project? (I have two: ‘ID’ ‘VB’ =)

>

Allowing any two letter acronyms may result in appearance of unwanted
names in your project: “ResultOK, UP, DOAnalysis, etc”. So our analysis
allows using of ‘generally accepted’ acronyms only.

>

We have plans to extend acronyms with ability to provide the only one
possible spelling for a word (that will suggest you to use ID instead of
Id). As you can see this is a more strict analysis. But I think that it a
good practice to have all ‘ID’ identifiers in the unified form.

>
>
>

---
Original message URL:
http://www.jetbrains.net/devnet/message/5235532#5235532


0

Anyone?

"Paul Bradshaw" <pbradshaw@advsol.com> wrote in message
news:gslbp4$5ds$1@is.intellij.net...

Where is the "abbreviation list" stored? Can it be edited manually? I
couldn't find it...

>

I have a situation where the abbreviation comes at the beginning of a
parameter name. It's a two letter abbreviation and it's used throughout
the code. For some reason, I guess because it starts with a capital
letter, it doesn't prompt me to add this two letter abbreviation to the
abbreviation list... so I have a lot of underlined code that isn't going
to change, and with no way to disable the underlines without losing all
the normal benefits of this analysis.

>

Basically, I need to specify specific exceptions. To use your example
with ID... if a parameter is IDs (plural), that should be allowed by our
standards. But ids and Ids should be underlined, and any arbitrary two
letters or capitalized first letter should be underlined.

>

How do go about this?

>

Help? I'd like to add our
"Sergey Shkredov" <no_reply@jetbrains.com> wrote in message
news:10519723.70571239341652138.JavaMail.clearspace@app8.labs.intellij.net...

>>
>> Hi.
>>
>> We don’t an option to ignore capitalized two letter acronyms. Do you have
>> a lot of such acronyms in your project? (I have two: ‘ID’ ‘VB’ =)
>>
>> Allowing any two letter acronyms may result in appearance of unwanted
>> names in your project: “ResultOK, UP, DOAnalysis, etc”. So our analysis
>> allows using of ‘generally accepted’ acronyms only.
>>
>> We have plans to extend acronyms with ability to provide the only one
>> possible spelling for a word (that will suggest you to use ID instead of
>> Id). As you can see this is a more strict analysis. But I think that it a
>> good practice to have all ‘ID’ identifiers in the unified form.
>>
>>
>>
>> ---
>> Original message URL:
>> http://www.jetbrains.net/devnet/message/5235532#5235532


0

Anyone?

"Paul Bradshaw" <pbradshaw@advsol.com> wrote in message
news:gslbp4$5ds$1@is.intellij.net...

Where is the "abbreviation list" stored? Can it be edited manually? I
couldn't find it...

>

I have a situation where the abbreviation comes at the beginning of a
parameter name. It's a two letter abbreviation and it's used throughout
the code. For some reason, I guess because it starts with a capital
letter, it doesn't prompt me to add this two letter abbreviation to the
abbreviation list... so I have a lot of underlined code that isn't going
to change, and with no way to disable the underlines without losing all
the normal benefits of this analysis.

>

Basically, I need to specify specific exceptions. To use your example
with ID... if a parameter is IDs (plural), that should be allowed by our
standards. But ids and Ids should be underlined, and any arbitrary two
letters or capitalized first letter should be underlined.

>

How do go about this?

>

Help? I'd like to add our
"Sergey Shkredov" <no_reply@jetbrains.com> wrote in message
news:10519723.70571239341652138.JavaMail.clearspace@app8.labs.intellij.net...

>>
>> Hi.
>>
>> We don’t an option to ignore capitalized two letter acronyms. Do you have
>> a lot of such acronyms in your project? (I have two: ‘ID’ ‘VB’ =)
>>
>> Allowing any two letter acronyms may result in appearance of unwanted
>> names in your project: “ResultOK, UP, DOAnalysis, etc”. So our analysis
>> allows using of ‘generally accepted’ acronyms only.
>>
>> We have plans to extend acronyms with ability to provide the only one
>> possible spelling for a word (that will suggest you to use ID instead of
>> Id). As you can see this is a more strict analysis. But I think that it a
>> good practice to have all ‘ID’ identifiers in the unified form.
>>
>>
>>
>> ---
>> Original message URL:
>> http://www.jetbrains.net/devnet/message/5235532#5235532


0

Anyone?

"Paul Bradshaw" <pbradshaw@advsol.com> wrote in message
news:gslbp4$5ds$1@is.intellij.net...

Where is the "abbreviation list" stored? Can it be edited manually? I
couldn't find it...

>

I have a situation where the abbreviation comes at the beginning of a
parameter name. It's a two letter abbreviation and it's used throughout
the code. For some reason, I guess because it starts with a capital
letter, it doesn't prompt me to add this two letter abbreviation to the
abbreviation list... so I have a lot of underlined code that isn't going
to change, and with no way to disable the underlines without losing all
the normal benefits of this analysis.

>

Basically, I need to specify specific exceptions. To use your example
with ID... if a parameter is IDs (plural), that should be allowed by our
standards. But ids and Ids should be underlined, and any arbitrary two
letters or capitalized first letter should be underlined.

>

How do go about this?

>

Help? I'd like to add our
"Sergey Shkredov" <no_reply@jetbrains.com> wrote in message
news:10519723.70571239341652138.JavaMail.clearspace@app8.labs.intellij.net...

>>
>> Hi.
>>
>> We don’t an option to ignore capitalized two letter acronyms. Do you have
>> a lot of such acronyms in your project? (I have two: ‘ID’ ‘VB’ =)
>>
>> Allowing any two letter acronyms may result in appearance of unwanted
>> names in your project: “ResultOK, UP, DOAnalysis, etc”. So our analysis
>> allows using of ‘generally accepted’ acronyms only.
>>
>> We have plans to extend acronyms with ability to provide the only one
>> possible spelling for a word (that will suggest you to use ID instead of
>> Id). As you can see this is a more strict analysis. But I think that it a
>> good practice to have all ‘ID’ identifiers in the unified form.
>>
>>
>>
>> ---
>> Original message URL:
>> http://www.jetbrains.net/devnet/message/5235532#5235532


0

Please sign in to leave a comment.