[AI 기초 다지기] 파이썬 - 함수 개발 가이드라인

- 함수 개발 가이드라인

1. 함수는 가능하면 짧게 작성 > 줄 수를 줄일 것
2. 함수 이름에 함수의 역할, 의도가 명확히 들어낼 것
3. 하나의 함수에는 유사한 역할을 하는 코드만 포함
4. 인자로 받은 값 자체를 바꾸진 말 것 > 임시변수 선언
5. 공통적으로 사용되는 코드는 함수로 변환
6. 복잡한 수식, 조건 > 식별 가능한 이름의 함수로 변환

#bad
def count_word(string_variable):
	string_variable = list(string_variable) 
	return len(string_variable
    
#good
def count_word(string_variable):
	return len(string_variable)

 

- How to write good code?

• 코딩 컨벤션 : 사람의 이해를 돕기 위한 규칙
• 명확한 규칙은 없음
• 팀 or 프로젝트마다 다름
• 중요한 건 일관성!
  
  
• 들여쓰기 공백 4칸 권장
• 한 줄은 최대 79자까지
• 불필요한 공백은 피함
• = 연산자는 1칸 이상 안 띄움
• 주석은 항상 갱신, 불필요한 주석은 삭제
• 코드 마지막에는 항상 한 줄 추가
• 소문자 l, 대문자 O, 대문자 I 금지
• 함수명은 소문자로 구성, 필요하면 밑줄로 나눔

 

- PEP8 : 파이썬 코딩 컨벤션의 기준

• "flake8" 모듈로 체크 – flake8 <파일명>

• 최근에는 black 모듈을 활용 > 명령어 = black codename.py
• 자동으로 오류를 수정해 줌 > 활용을 습관화하는 것이 좋음