본문 바로가기
지식/잡학지식

잡학지식)코딩 컨벤션(Coding Conventions)

by 테샤르 2021. 12. 13.

코딩 컨벤션(Coding Conventions)

 

본인이 아닌 다른 사람들도 내가 작성한 코드를 보고 쉽고 빠르게 이해할 수 있도록 작성한 코드 표준이다.

코딩 컨벤션은 관리과 쉽고 읽기가 쉬운 일종의 코딩 스타일 규약이다.

코딩규칙은 콘텐츠에 집중할수 있도록 코드에 대한 일관적인 형태를 취합니다.

코드를 보게되면 바로 이해할 수 있고 쉽게 표현되어야 합니다.

코드 복사, 변경 유지 관리를 용이하게 됩니다. (Camel Case, Pascal Case) 등도 이에  포함됩니다.

 

<레이아웃 규칙>

한 줄에 한문장만 작성합니다.

텝으로 들여쓰기 합니다.

메서드 정의와 속성 정의 사이의 하나 이상의 빈 줄을 추가합니다.

 

 

<주석 처리 규칙>

코드의 개행은 끝이 아닌 별도의 행에 주석을 배치한다.

대문자로 주석 텍스트를 시작합니다.

마침표로 주석 텍스트를 시작합니다.

다음과 같은 예의 주석 구분 기호(//)와 주석 텍스트 사이에 공백을 하나 삽입합니다.

// The following declaration creates a query. It does not run
// the query.

 

MS  - C# Coding Conventions  : [ 링크 ]

 

C# Coding Conventions

Learn about coding conventions in C#. Coding conventions create a consistent look to the code and facilitate copying, changing, and maintaining the code.

docs.microsoft.com

Net. C# Coding Convention: [ 링크 ] 

 

GitHub - dotnet/runtime: .NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.

.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps. - GitHub - dotnet/runtime: .NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.

github.com

결론으로는 코드를 작성하는 규약을 정하는 것으로

일반적으로 많이 사용되는 형식에서 편리한 형태로 작성하면 된다.

 

★☆☆☆☆

 

반응형

댓글