2006/12/31 18:15 Developer
자바에서의 주석 어떻게 사용하세요?
안영회님의 흥미로운 주석의 위치 라는 글을 읽다가 전에 오픈소스를 보다가 주석의 위치에 감동이 받은 적이 있어서 그것에 관련된 얘기를 적어볼까 한다.
아래와 같은 주석은 1.5 generic에서는 활용도가 떨어지지만, 주석에 대한 사고를 넓혀주기에 충분한 예제라고 생각이 들어서 적어본다.
ex1)
List /*Person*/ getListAll();
ex2) 1.5에서는 generic이 가능해서 주석이 필요가 없다.
List<Person> getListAll();
언어차원에서 지원이라고 하는게 더 적합하겠다.
과거에는 List라는 곳에 무엇이 들어있는가 궁금해서, getPersonListAll()이라던가, 그 안에 들어갈 객체를 다른 방법을 써서 표시를 해야 했는데, 주석을 코드 사이에 넣어주면, 좀더 이해하기가 쉬운 코드가 된다.
고정관념을 깨뜨리는 것은 좀더 인간이 이해하기 쉬운, 코드로서 설명을 할수 있는, 별도의 문서화가 필요가 없는 코드를 작성을 할수 있을 것이다.
근데, 너무 오바하면 가독성을 더 해치기도 한다....;)
아래와 같은 주석은 1.5 generic에서는 활용도가 떨어지지만, 주석에 대한 사고를 넓혀주기에 충분한 예제라고 생각이 들어서 적어본다.
ex1)
List /*Person*/ getListAll();
ex2) 1.5에서는 generic이 가능해서 주석이 필요가 없다.
List<Person> getListAll();
언어차원에서 지원이라고 하는게 더 적합하겠다.
과거에는 List라는 곳에 무엇이 들어있는가 궁금해서, getPersonListAll()이라던가, 그 안에 들어갈 객체를 다른 방법을 써서 표시를 해야 했는데, 주석을 코드 사이에 넣어주면, 좀더 이해하기가 쉬운 코드가 된다.
고정관념을 깨뜨리는 것은 좀더 인간이 이해하기 쉬운, 코드로서 설명을 할수 있는, 별도의 문서화가 필요가 없는 코드를 작성을 할수 있을 것이다.
근데, 너무 오바하면 가독성을 더 해치기도 한다....;)
