Form

별도의 문서에 coding standards를 작성하는 것은 추천하지 않는다.

코드 자체가 coding standards가 되어야 한다.

커멘트는 코드에 나와있는 내용을 적으면 결국 의미가 없는 커멘트라 생각하고 독자들은 읽지 않게된다.

정작 필요한 커멘트를 작성했는데도 아무도 보지않게되는 불상사가 일어나게 된다.

즉 커멘트를 꼭 필요한 내용에서만 작성해야하는데 과거 Assembly언어들은 표현력이 다소 떨어졌던 언어들이였다 지금은 대부분의 언어가 뛰어나게 코드를 작성할 수 있기 때문에 좋은 코드를 작성하는데 노력을 더 하는것이 바람직하다.

꼭 작성해야하는 커멘트 종류

위의 공통적인 것들은 사용자들이 알면 작성자에게 감사할 것들이다. 이런 내용들을 커멘트로 작성해야 한다.

반대로 적으면 안되는 코멘트도 있다.

공란을 마구잡이 식으로 사용하여 독자들에게 혼란을 주는 경우가 많이 존재한다.

아래는 저자가 코드에서 공란 표기를 추천하는 부분이다.

관련된 부분들을 한곳에 같이 놔두는 것도 중요한 포인트이다.

앞서 계속 말했던 것처럼 객체간의 의존성을 낮춰야한다.

클래스는 private 변수들을 public 함수로 조작하고, private 변수는 외부에서 존재하는지 조차 몰라야한다.

그렇기에 getter, setter, property등을 제공하는 것은 나쁜 설계다.

객체지향에서 가장 중요한 개념인 “의존성은 낮되, 결합도는 높아한다”를 지키려면 getter, setter는 좋지 않은 코드다. getter, setter는 10개의 변수가 있다면 1개씩 밖에 사용하지 않는다.

그렇다고 getter를 사용하지 않을 수는 없기에, 추상화 개념을 사용하는 것이다.

gallonsOfGas변수를 getPercentFuelRemaining()함수가 접근하지만 사용자의 입장에서는 알수가 없다. 이것이 다형성을 지원하는 좋은 코드이다.

참조