참고: 소프트웨어공학 강의 자료 p.175 ~ 183 + 수업 필기
- 코딩: 설계서를 입력으로 원시 코드 작성
- 언어마다 코딩 규칙이 있음
- 지키면 좋은 점
- 가독성 향상 (주석, 들여쓰기, 공백)
- 간결하고 명확한 코드
- 개발 시간 단축
- 이름은 31자 이내
- 변수명과 함수명은 다르게 (
sum/getSum()) - 변수명은 소문자로 시작, 함수명은 소문자 + 동사로 시작
- 상수명·매크로명은 대문자와
_ - 포인터 변수는 앞에
p(pSum)
- 소스 파일 하나는 200줄 이내
- 한 줄은 80자 이내
- 함수 내용은 70줄 이내
- 여는 중괄호
{는 문장 끝에, 닫는 중괄호}는 문장 시작에 - 한 문장을 두 줄로 쓸 때: 80자가 넘으면 쉼표 뒤에서 줄바꿈, 둘째 줄은 앞 줄 표현식에 맞춤
- 수준이 같은 문장은 시작 위치를 맞춤
- 코드를 검사해 주는 도구가 있음
- 보충
- 파이썬은
flake8,pylint,ruff같은 린터가 자동 검사 - PEP(Python Enhancement Proposal) 8 기준 한 줄은 79자
- 파이썬은
- 보충
- 코드 첫 주석: 작성자, 작성일·변경일, 목적, 개정 이력, 저작권
- 메서드 앞 주석: 목적, 매개변수, 반환값, 변경 이력
- 코드와 주석은 명확히 구분, 내용 일치 필요
- 용도가 같은 변수는 한 줄에 선언, 필요한 변수만 선언
- 배열은 요소 수를 명시하고 초기화
- 지역 변수는 선언할 때 초기화
- 8진수 지양 (가독성 저하) → 10진수, 16진수 사용
- 숫자 리터럴은
const변수로 이름 붙여 사용 → 의미 파악 쉬움
- 단항·이항·삼항 연산자는 바른 표기(공백 규칙) 지키기
switch문:case마다break, 마지막에defaultgoto문 사용 지양for문 제어 변수에 실수값 사용 Xbreak문은 가능하면 한 번만if ~ else if문은else로 끝내기