서술적인 이름 짓기

1. 이름을 지을 때 서술적인 이름을 짓기 위한 노력이 필요하다.

class Test{

		public String a(){
			return "100점입니다."; 
		} 

		public String getS(){
			return s; 
		} 

}

• 개인적으로 작성한 코드지만 어떤 의미를 가졌으며 , 어떤 일을 하는 코드인지 쉽게 파악하기 어렵다.
• 주석을 작성하면 편할까? → 물론 가독성과 해석은 편해졌지만 코드 수가 길어져 복잡할 가능성이 있다. 하지만 그렇다고 아예 안쓰는건 아닌거같다.
• 메서드 명 , 변수 명, 클래스 명 등등.. 작성한 코드에 대한 서술적인 네이밍을 사용한다면, 주석을 길게 달지 않아도 네이밍만 보고 어느정도 해당 코드가 동작하는 원리를 이해할 수 있을꺼같다.

그렇다면 주석문은 언제 사용하는 것이 좋을까?

주석문의 적절한 사용

설명되지 않은 값을 사용할땐

1. 잘 명명된 상수를 사용

3.141592...

private final Double PIE_NUMBER = 3.141592....

1. 잘 명명된 함수를 사용