docs(sample): Javadoc @param 이름을 실제 파라미터명으로 수정

[wantaekchoi]

수정 사유 Reason for modification

• 버그수정 Bug fixes
• 기능개선 Enhancements
• 기능추가 Adding features
• 기타 Others

수정된 소스 내용 Modified source

Javadoc @param 세 줄이 실제 파라미터에 없는 이름을 적고 있습니다. 고칠 이름은 같은 파일과 같은 계층이 정해 줍니다.

파일	줄	적힌 이름	실제 파라미터
sample/service/EgovSampleService.java	69	searchVO	vo
sample/service/EgovSampleService.java	76	searchVO	vo
sample/web/EgovSampleController.java	144	id	sampleVO

selectSampleList·selectSampleListTotCnt 는 구현체 EgovSampleServiceImpl 과 SampleMapper 가 같은 시그니처를 @param vo 로 적고 있어 인터페이스만 어긋나 있습니다. updateSampleView 는 같은 컨트롤러에서 Javadoc 이 달린 나머지 핸들러 다섯 개가 모두 @param sampleVO 를 쓰고, 이 메서드에도 id 라는 파라미터가 없습니다.

pom.xml 에 maven-javadoc-plugin 설정이 없어 빌드에서는 드러나지 않습니다.

주석 3줄만 바꾸었고 코드와 시그니처는 그대로입니다(2파일, +3/-3). 줄바꿈(CRLF)은 원본대로 보존했습니다.

검증

javadoc -Xdoclint:all 로 두 파일의 수정 전후를 비교했습니다(JDK 21, -sourcepath src/main/java 와 프로젝트 의존성 classpath 지정).

수정 전

.../web/EgovSampleController.java:144: error: @param name not found
.../service/EgovSampleService.java:69: error: @param name not found
.../service/EgovSampleService.java:76: error: @param name not found

수정 후 세 줄이 사라집니다. 이름이 어긋난 @param 이 실제 파라미터를 문서화하지 못해 함께 떠 있던 no @param for sampleVO / no @param for vo 경고 3건도 같이 해소됩니다.

src/main/java 전체를 @param 이름 대 시그니처로 대조했고 어긋난 곳은 위 세 줄뿐입니다. void 메서드에 붙은 @return void형 표기는 이 저장소 전반의 관례라 손대지 않았습니다.

JUnit 테스트 JUnit tests

• JUnit 테스트 JUnit tests
• 수동 테스트 Manual testing

주석만 바뀌어 바이트코드가 그대로이므로 단위 테스트는 해당 없습니다. 위 javadoc 실행으로 대신했습니다.

테스트 브라우저 Test Browser

• Chrome
• Firefox
• Edge
• Safari
• Opera
• Internet Explorer
• 기타 Others

해당 없음 (화면 영향 없음)

테스트 스크린샷 또는 캡처 영상 Test screenshots or captured video

위 javadoc 출력으로 대신합니다.

[jei007]

표준프레임워크에 대한 지속적인 참여에
대단히 감사드립니다.