Younghoe.Info v3

모델2 환경에서 흔히 쓰이는 3 계층 구조를 쓰는 경우 어떤 스타일로 javadoc을 써야 할까 정리한 내용. 정보 시스템 유지보수 맥락(context)이다.

1. Controller 계층

• 어떤 사용자 이벤트에 의해 화면에 호출되는지 기록한다. 화면 나타나는 사용자 메뉴 이름이나 어떤 GUI 요소를 클릭(혹은 키 입력)했을 때 불리며 결과는 어떤지 기술한다. ... 예: 메뉴 목록 트리에서 특정 메뉴를 선택할 때 메뉴를 사용할 수 있는 그룹과 권한을 출력
  
• 화면을 통한 입출력 데이터를 쉽게 알 수 있게 쓴다. 또한, 클래스가 아니라 IDE Navigation이 불편한 경우 즉, Map이나 Data Set 등을 쓰는 경우는 보완책을 마련한다.

2. Service 계층

• 메소드 의도와 함께 코드 순서와 분기, 반복으로 나타나는 비즈니스 로직 설명 포함
• 데이터 무결성(Data Integrity) 보장을 위해 DAO 메소드 호출 순서 등을 설명(비즈니스 로직의 선후행 조건 기술) ... 예: 메뉴 목록 삭제. 메뉴 삭제를 위해서는 프로그램별 그룹 목록을 먼저 지워야 한다.
  

3. DAO 계층

• 조건(where)절의 킷값이 드러나도록 작성. 예: 특정 하위 시스템에 메뉴고유번호로 등록한 프로그램별 그룹 레코드를 모두 삭제한다.
• 입력 값이 클래스가 아니라 일반적인 Collection인 경우 역시 부가 설명이나 Navigation 기법 필요.
  

관련 글:

• javadoc에서 <p> 태그를 쉽게 넣는 설정
• Javadoc 관련 플러그인: jAutodoc
• 이클립스의 javadoc Ant 타겟 생성 기능
• javadoc에 link 넣기
  

M1  Friday, August 21, 2009

M2  Friday, October 2

M3  Friday, November 13

M4  Friday, December 18

M5  Friday, February 5, 2010

M6  Friday, March 19

EclipseCon! March 22

M7  Friday, May 7

RC1 Friday, May 21

RC2 Friday, May 28

RC3 Friday, June 4

RC4 Friday, June 11

Release Wednesday, June 23


출처: Helios Simultaneous Release



이유는 모르겠지만, 다른 문서와 일정 차이가 조금 있다. 구체적으로 알고 싶으면 구글 카렌더를 공유한다.

1. javadoc 작성할 때 문단을 위핱 태그 삽입

• Name: p
• Context: javadoc
• Description: Paragraph for javadoc
• Pattern

10여년쯤 전에는 신의손이라는 것이 유행했다.
오타없는 빠른 타이핑 실력을 자랑하던 이름
적어도 700타 정도는 쳐야 명함을 내민다던

그후로도 오랫동안 타이핑의 로망스는 계속되고 있지만...


버릇처럼 변수명을 치다가 어느 순간 이클립스에서 무심코 Ctrl+Space를 눌러서
Code Assist 기능 활용해본 적이 있다.

그리고 오늘, HttpMethod 객체의 변수의 이름으로 httpMethod가 좋을지 method가 좋을지 생각을 함과 동시에 습관이 된 Code Assist를 실행해본다.

와우~ Naming Assist 역할도 해준다.

이를 적극적으로 활용하면 타수를 줄어들게 될 수도 있지만^[각주:1]
무분별한 작명을 막아줄 수 있는 좋은 습관을 갖는데 도움이 될만하다.

위와 같이 이미 작성한 코드 중에서 특정 영역을 try - catch로 묶고 싶다고 하자. 일일이 손으로 코딩하게 되면 먼저 블럭 지정을 한 후에 Ctrl+X 키로 잘라내고 (이때, 화장실 가고 싶으면 잠시 참아야 한다) try{ 까지를 타이핑 하고 엔터키를 친 후에 그 안에다가 Ctrl+V를 한다.

이클립스에 관련 기능이 있을까 해서 찾아봤다.

역시 있다. Surround With라고 Refactor와 다르게 묶여서 제공된다. 그림에 보이는 것처럼 반복/조건/동기화문과 같은 다양한 유형의 블럭을 함께 지원한다. try-catch의 경우에는 발생하는 예외 타입을 알아서 포착해준다.