Coding Convention and Rules

Necessity of coding convention

소프트웨어를 개발하는 일련의 모든 과정에 들어가는 비용 중 80%가 유지보수
소프트웨어의 유지보수를 그 소프트웨어를 직접 개발한 개발자가 담당하는 경우는 드물다
코딩 컨벤션은 다른 개발자가 그 소스코드를 처음 보았을 때, 더 빠른 시간에 완벽히 이해할 수 있도록 도와주기 때문에, 코드의 가독성이 높아진다.
개발자가 자신의 소스 코드를 제품으로 팔고자 한다면, 자신이 작성한 코드가 다른 소스코드들과 잘 어울리도록 패키지(package)를 적절하게 구성할 필요가 있다.

최적화 VS 가독성. 최적화보단 가독성

코드는 항상 읽기 쉽고 개발자들이 이해할 수 있게끔 작성하라. 읽기 어려운 코드를 읽는데 소모되는 시간과 비용은 최적화로부터 얻을 수 있는 것보다 더욱 크다.

간단하고 단순하게

복잡한 코드를 작성하지 말라. 간단하게 작성하면 버그가 줄어들고 디버깅 시간도 줄어들 수 있다.

코드 리뷰

코드 리뷰는 좋을 수도 있고 나쁠 수도 있다. 여러분의 팀에 코드의 95%를 이해하고 있고 시간 낭비 없이 모든 업데이트 사항을 모니터링 할 수 있는 개발자가 있는 경우에만 코드 리뷰를 도입하도록 하라.

피곤하거나 컨디션이 좋지 않을때 코딩하지 말라

개발자들이 피곤할 땐 평소보다 2-5배 더 많은 버그와 실수를 만들어낸다. 따라서 과업은 매우 나쁘다.

다른 사람들을 존중

자신보다 못하다고 남을 비하하거나 무시하는 행위는 팀의 능률에 지장이 될 수 있다.

괄호 표기는 기본적으로 K&R표기를 따른다.
함수 명칭의 작성 스타일은 카멜(Camel)표기법과 파스칼(Pascal)표기법을 따릅니다.

ex) 카멜표기법 -> cameVariable 파스칼표기법 -> CameVariable
변수 명칭은 띄어쓰기시 "_"를 붙이며 가독성이 있게 표기만 하면 된다.
들여쓰기는 탭으로만 합니다.
변수 작성시 그 쓰임새와 일치하게끔 변수이름을 지정하십시오.
액티비티나 xml 파일 이름은 xxxActivity , activity_xxx 이런 식으로 작성해주십시오
주석은 되도록 최소한으로 적어주시고 코드를 가독성 있게 짜는 걸 목표로 짜십시오.