Refactoring/Simple 썸네일형 리스트형 L.I.N.E ! (줄맞추기) 여러 사람들이 개발한 소스를 보면서 한가지 특징을 몸에 채득하고 지내고 있다. 주위 개발자들에게도 자주 이야기를 했던 내용이다. 내가 여태까지 본 개발 소스중에서 줄이 잘 맞춰져 있는 소스일 수록 코드의 퀄리티가 좋았다. 소스코드의 줄 맞추기를 하지 않고 어떤 부분은 두칸 띄우기 어떤 부분은 세칸 띄우기 어떤 부분은 1줄 비우기 어떤 부붑은 2줄 비우기 등 규칙성이 없이 짜여진 소스의 퀄리티는 대다수가 좋지 않았다. 보통 줄맞추기가 형편 없을 수록 변수명이나 로직자체도 형편 없이 진행되는 경우가 많았다. 왜일까? 소스코드를 잘 짠다는 것은 읽기 좋게 짠다는 것이다. 읽기가 좋으려면 일단 기본적으로 들여쓰기 내쓰기 줄 바꿈이 규칙적이고 일목요연하게 되어있어야 한다. 그렇지 않으면 뇌는 혼선을 가지게 된다... 더보기 주석?! 본 코드는 아쉽게도 정말 실전에서 사용되는 코드이다. 오늘 발견된 웃픔 코드이다. 위에 코드에는 여러가지 문제가 많지만 그중에서 주석에 대해서 이야기를 하고자 한다. 1. JavaDoc 주석 상기 소스코드를 보면 상단에 JavaDoc을 위한 주석이 포진해 있고 하위에는 각 스텝별로 주석이 달려있다. JavaDoc이 왜 필요할까 부터 우리는 생각을 해봐야 될 것 같다. JavaDoc은 소스코드상에달린 JavaDoc의 주석 규칙을 따르게 되면 코드를 작성하며 나타나는 코드 컴플리에서 변수가 무슨 형인지 어떤 역활을 하는 메서드인지 도움말을 표기해줄 수 있는 아주 유용한 도구이다. 이런 도구가 없으면 별도로 메서드의 선언과 그 파라메터에 대한 정의와 도움말을 작성해야되며 이는 실제 메서드의 정의와 작성의 일치.. 더보기 이전 1 다음
