Development Tip

약어에 대한 C # 명명 규칙

yourdevel 2020. 11. 30. 20:05
반응형

약어에 대한 C # 명명 규칙


약어에 대한 C # 명명과 관련하여 Windows API와 관련된 라이브러리를 작성하는 경우 WindowsApi 또는 WindowsAPI에 대한 강력한 규칙이 있습니까? 아니면 개인적인 선호입니까?


규칙이 있으며 2 자 이상의 모든 약어에 대해 초기 대문자, 나머지 소문자를 지정합니다. 따라서 HttpContextClientID.


" 프레임 워크 디자인 지침 "2nd edition by Krzysztof Cwalina 및 Brad Abrams pp.40-42

3.1.2 대문자 화 약어

DO은 낙타 맡았다 식별자의 첫 번째 단어를 제외하고, 두 문자 약어에 모두 문자를 대문자로.

System.IO
public void StartIO(Stream ioStream)

DO는 낙타 맡았다 식별자의 첫 단어를 제외하고, 세 개 이상의 문자 약어의 첫 번째 문자를 대문자로.

System.Xml
public void ProcessHtmlTag(string htmlTag)

길이에 관계없이 낙타로 구분 된 식별자의 시작 부분에 두문자어의 문자를 대문자로 사용하지 마십시오 .


여기에서 Microsoft의 공식 명명 지침을 확인하십시오. 명명 지침


약어를 피해야한다고 들었으므로 WindowsApplicationProgrammingInterface, 그러면.

더 심각하게 (사람들은 아래 인용에도 불구하고 위의 내용을 잘못 읽는 것 같습니다) 이 페이지 는 다음 같이 말합니다.

세 글자 이상의 두문자어는 모두 대문자가 아닌 파스칼 케이스 여야합니다.

API는 잘 알려진 약어로 간주 WindowsApi되므로 가이드 라인을 따르려면 이름 을 선택해야합니다.


오래된 질문, 새로운 답변.

약어에 대한 .NET 4 대문자 표기 규칙에 따르면 :

낙타로 된 식별자의 첫 번째 단어를 제외하고 두 문자로 된 두문자어의 두 문자를 모두 대문자로 사용하십시오.

이름 DBRate지정된 속성 DBPascal 케이스 식별자의 첫 번째 단어로 사용되는 짧은 약어 ( ) 의 예입니다 . 이름 ioChannel지정된 매개 변수 IO는 낙타로 구분 된 식별자의 첫 단어로 사용되는 짧은 약어 ( ) 의 예입니다 .

낙타로 구분 된 식별자의 첫 번째 단어를 제외하고 세 개 이상의 문자로 두문자어의 첫 번째 문자 만 대문자로 사용하십시오.

명명 된 클래스 XmlWriter는 파스칼 케이스 식별자의 첫 번째 단어로 사용되는 긴 약어의 예입니다. 이름 htmlReader지정된 매개 변수 는 낙타 케이스 식별자의 첫 번째 단어로 사용되는 긴 약어의 예입니다.

길이에 관계없이 낙타로 구분 된 식별자의 시작 부분에 두문자어의 문자를 대문자로 사용하지 마십시오.

이름 xmlStream지정된 매개 변수 xml는 낙타로 구분 된 식별자의 첫 번째 단어로 사용되는 긴 약어 ( ) 의 예입니다 . 이름 dbServerName지정된 매개 변수 db는 낙타로 구분 된 식별자의 첫 번째 단어로 사용되는 짧은 약어 ( ) 의 예입니다 .


개인적인 취향. 그러나 .NET은 WindowsApi. 의 이름과 비슷합니다 TcpClient.


그것은 모두 개인적 (또는 조직적) 선호 일뿐입니다. 일관성이있는 한 괜찮을 것입니다.

.NET Framework 자체는 WindowsApi를 사용합니다.


FxCop도 살펴보십시오. 이와 같은 문제를 해결하는 데 도움이되는 멋진 유틸리티입니다.

참고 URL : https://stackoverflow.com/questions/2109171/c-sharp-naming-conventions-for-acronyms

반응형