Skip to content

docs(codegen): CRUD 템플릿 생성 주석의 엔티티명 변수화 복원 - #137

Closed
EricSeokgon wants to merge 4 commits into
eGovFramework:mainfrom
EricSeokgon:fix/codegen-template-comments
Closed

docs(codegen): CRUD 템플릿 생성 주석의 엔티티명 변수화 복원#137
EricSeokgon wants to merge 4 commits into
eGovFramework:mainfrom
EricSeokgon:fix/codegen-template-comments

Conversation

@EricSeokgon

Copy link
Copy Markdown
Contributor

요약

CRUD 코드 생성 템플릿(crud/java)의 javadoc 주석이 엔티티와 무관하게 "글을 등록한다"로 하드코딩되어 있어, 어떤 엔티티로 생성해도 주석이 전부 "글" 기준으로 출력됩니다. ${model.entity.name} 기반 표기로 복원합니다. 코드 영역은 변경하지 않습니다.

문제 (재현)

  • egovframework.dev.imp.codegen.template.templates/eGovFrameTemplates/crud/java/ 하위 4개 템플릿의 javadoc 주석 24곳이 "글을 등록한다/수정한다/삭제한다/조회한다", "글 목록…" 등으로 고정되어 있습니다.
  • 예: 엔티티명 "회원"으로 생성해도 MemberService.java의 주석은 * 글을 등록한다.
  • [질문] CRUD 코드 생성 템플릿 두 벌(codegen.template.templates / templates)의 정본 확인 요청 #135 답변에 따라 검증/테스트용 트리(egovframework.dev.imp.templates)를 비교한 결과, 같은 자리들이 ${model.entity.name} 변수화로 남아 있습니다. 과거 표기가 이후 개편 과정에서 하드코딩으로 되돌아간 것으로 보여, 그 표기를 복원하는 취지입니다. 의도된 변경이었다면 알려주시면 따르겠습니다.

수정

  • EgovSample2Service.vm / EgovSample2ServiceImpl.vm / Sample2Mapper.vm / EgovSample2Controller.vm 의 주석 24곳 (+24/−24, 주석 라인만)
  • 글을 등록한다.${model.entity.name}을 등록한다., 글 목록을 조회한다${model.entity.name} 목록을 조회한다, @return 글 목록@return ${model.entity.name} 목록
  • 조사(을/를) 고정은 기존 표기를 따랐습니다. 을(를) 표기를 선호하시면 반영하겠습니다.

검증 (실측)

  • Velocity 2.3 렌더 스모크: 수정 전/후 템플릿을 동일 컨텍스트로 렌더링해 생성물 비교 — 엔티티 2종(회원/Member, 부서코드/DeptCode) × 4템플릿 = 8쌍
  • 비주석 diff 0라인, 변경은 주석 48라인(24곳×2종)뿐 — 메서드 선언부 해시 동일 확인
  • 예: * 글을 등록한다.* 회원을 등록한다. / * 부서코드 목록을 조회한다. (pageing)

영향 범위

  • 생성 코드의 동작·시그니처 무변경(주석 텍스트만). CRUD 코드 생성 사용자의 생성물 주석 품질 개선
  • jsp 템플릿의 JS 주석 3곳("글 수정 화면 function" 등)은 기존 변수화 전례가 없어 이번 범위에서 제외했습니다. 필요하시면 후속으로 처리하겠습니다.

Refs #135

Updated method documentation to reference ${model.entity.name} instead of '글'.
Updated comments in Sample2Mapper.vm to include model entity names.
@EricSeokgon

Copy link
Copy Markdown
Contributor Author

같은 취지의 #136이 더 넓은 범위(java 4파일 35곳 + jsp 3곳 = 38곳)로 먼저 열려 있었습니다. 이 PR의 변경 24곳은 #136에 전부 포함되는 부분집합이라, 중복 리뷰 부담을 없애기 위해 이 PR을 닫고 #136으로 일원화합니다.

이 PR에서 수행한 Velocity 2.3 렌더 검증(엔티티 2종 × 템플릿, 비주석 diff 0)은 #136 기준으로 다시 실행해 해당 PR에 코멘트로 남겼습니다. 혼선을 드려 죄송합니다.

Refs #135, #136

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant