[Python Basic] 08. 코딩 형식

0. 코딩 형식

코딩을 하다보면 개인별로 자주 사용하는 패턴이 만들어지고 점차 굳어지게 되면 습관화가 된다. 

이런 습관은 자신이 제작한 프로그램이나 다른 사람이 작성한 프로그램을 읽고 수정할 때 많은 영향을 미치게 되어 있다.  특히 초보자 일수록 키보드 입력속도가 느려, 약어를 사용하는 경향이 많은데 매우 좋지 않은 습관이 아니다.  자신만이 알수 있는 코딩보다 빠른 키보드 입력 속도를 확보하여 남이 읽기 좋은 프로그램을 작성하는 것이 프로그래머로서의  바른 자세라 할 수 있다. 

1. 레이아웃 규칙

1) 들여쓰기는 텝지정(공백4자)를 기본으로 한다.

2) 한줄에 79자를 넘지 않도록 줄넘김을 사용한다. 

3) 가능하면 주석은 별도의 줄에 기록한다. 

4) 연산자 주변과 콤마 뒤에 스페이스를 넣고, 괄호 다음에는 스페이스를 넣지 않는다. 

5) 식별자 네이밍 규칙을 따른다. 

6) 문은 한줄에 하나씩만 작성한다. 

7) 선언 또는 정의를 할 때 한줄에 하나씩만 작성한다.

8) 연속된 문장은 들여쓰기를 한다. 

9) 클래스에서 속성과 메스드 정의간에 빈줄을 추가한다. 

10) 함수, 클래스, 함수내의 코드 블록 사이에는 빈줄을 추가한다.

 

2. 식별자별 네이밍 규칙

식별자	표기법	Python 적용
네임스페이스	파스칼 표기법	×
데이터 형식	파스칼 표기법	○
인터페이스	I가 포함된 파스칼 표기법	×
메서드	파스칼 표기법	○
속성	파스칼 표기법	×
이벤트	파스칼 표기법	×
필드	파스칼 표기법	×
열거형	파스칼 표기법	×
매개변수	카멜 표기법	○
클래스	파스칼 표기법	○
함수	파스칼 표기법	○
변수	파스칼 표기법	○
파라미터	카멜 표기법	○

3. 일반적인 네이밍 규칙

1) 약어를 사용하지 않는다.

2) i, n, s 등 의미 없는 값의 이름을  index, temp 등으로 대체한다.

3) 키워드(예약어)와 비슷한 이름을 사용하지 않는다.

4) boolean이 들어간 변수, 속성, 함수등은 is 접두어를 사용한다.

5) 파일명과 클래스명은 되도록 동일하게 사용한다.

6) 파일명은 파스칼 표기법을 사용한다.

7) 인코딩은 UTF-8 또는 ASCII로 지정한다.