출처: Code Complete 2, 김도균 감수, 정보 문화사


좋은 루틴 이름:

루틴이 하는 모든 것을 표현하라

의미가 없거나 모호하거나 뚜렷한 특징이 없는 동사들을 피하라

루틴 이름을 숫자만으로 구분하지 마라

필요한 길이만큼 루틴의 이름을 만들라 : 9~ 15자 사이가 좋다.

함수의 이름을 지을 때, 리턴 값에 대해서 설명하라 : cos(), customerId.Next() 등

프로시저의 이름을 지을 때, 확실한 의미를 가지는 동사 다음에 객체를 사용하라. : 동사+객체 PrintDocument()

반의어를 정확하게 사용하라 : FileOpen(), FileClose()

공통적인 연산을 위한 규약을 만들라 : employee.Get.Id(), emploee.Get.Age()


루틴의 길이:

루틴의 길이는 200줄을 넘기지 않도록 노력한다.


루틴의 매개변수 사용법:

매개변수를 입력-수정-출력 순서로 입력한다.

 매개변수를 무작위로, 또는 알파벳 순으로 정렬하는 것보다는, 입력만 가능한 것을 첫번째로, 입출력이 가능한 것을 두 번째로, 출력만 가능한 것을 세 번째로 나열하라.  이것은 C라이브러리의 규약과 충돌된다. (수정되는 매개변수를 처음에 입력한다)

고유한 in과 out키워드 생성을 고려해 보라

여러 루틴이 유사한 매개변수를 사용한다면, 유사한 매개변수들을 일관된 순서로 입력하라

모든 매개변수를 사용하라 : 사용하지 않으면 제거하라. 이것은 잠재적인 error의 요인이 된다.

상태나 오류 변수를 마지막에 입력한다.

루틴의 매개변수를 작업용 변수로 사용하지 마라.

매개변수에 대한 인터페이스 가정을 문서화하라.

매개변수에 사용할 입력, 수정, 출력 이름 규약을 고려하라.


'소프트웨어 엔지니어링' 카테고리의 다른 글

[용어] Payload란?  (0) 2014.07.18
[terminology] reap  (0) 2014.01.11
아파치 라이센스 2.0 사용법  (0) 2012.04.12
루틴: 설계  (0) 2011.11.09
Posted by code cat