주석

[클린 코드] 주석(2)

나쁜 주석 주석(1)에서 말한 케이스를 제외하고 나머지는 모두 나쁜 주석의 범주에 속한다. 일반적으로 대다수의 주석은 허술한 코드, 변명, 미숙한 결정을 합리화하는 독백이다. - 주절거리는 주석 주석을 달기로 했다면 충분한 시간을 들여 최고의 주석을 달도록 노력하라. 특별한 이유 없이 의무가 또는 프로세스에서 하라고 하니까 주석을 단다면 시간낭비다. 다음 코드를 보자 public void loadProperties(){ try{ String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE; FileInputStream propertiesStream = new FileInputStream(propertiesPath); loadProperties.l..

[클린 코드] 주석(1)

주석은 코드를 부연 설명해주는 역할을 한다. 하지만 주석으로 좋지 않은 방법으로 짜인 코드를 보완하진 못한다. 표현력이 풍부하고 깔끔하게 짜여진 코드는 주석이 사실상 거의 필요가 없다. 간단한 예를 들어보자 //직원에게 복지 혜택을 받을 자격이 있는지 확인한다. if((employ.flags & HOURLY_FLAG) && (employee.age > 65)); if(employ.isEligibleForFullBenefits()); 위 두 if문은 같은 비교를 하지만 누가 봐도 주석을 달지 않고도 코드만으로 의도를 분명히 할 수 있다. 이와 같이 대다수의 경우 주석으로 만들려는 설명을 함수로 풀어 표현하기에 충분하다. 하지만 특정한 경우에는 주석이 필요할 순 있다. 좋은 주석 법적인 주석 - 특정 회사가..