*해당 게시글은 <NAVER boostcourse> 에서 수강한 강의를 바탕으로 정리한 내용입니다.
함수 작성 가이드라인
- 함수는 가능하면 짧게 작성할 것
- 함수의 이름에 함수의 역할과 의도가 명확히 들어날 것
- 하나의 함수에는 유사한 역할을 하는 코드만 포함
- 인자로 받은 값 자체를 바꾸지 말 것
함수는 언제 만드는가?
- 공통적으로 사용되는 코드가 있을 때
- 복잡한 수식과 조건이 있을 때 -> 식별 가능한 이름의 함수로 변환
코딩 컨벤션
: 사람들이 잘 이해할 수 있도록하는 코드 작성 규칙
- 명확하고 절대적인 규칙은 없음
- 팀마다, 프로젝트마다 규칙이 다르기도 함
- 일관성이 가장 중요함 (혼용하지 않아야함)
- 들여쓰기 규칙 : Tab vs 4 space (일반적으로 4space를 권장함)
- 한 줄 내 최대 글자 수 제한 (ex. 79자까지)
- 불필요한 공백 제거
- = 연산자 앞뒤 1칸 공백
- 코드의 마지막엔 항상 한 줄 축
- 소문자 l, 대문자 O, 대문자 I 금지
- 함수 명은 소문자로 구성, 필요 시 밑줄로 나눔
- 'flake8' 모듈로 체크
등등...
flake8
코드 정적 분석기로, 코드 스타일 통일 및 잠재적 버그를 줄이기 위한 도구로 사용됨
Soominlee