백엔드 개발시 메서드 정의서 어떻게 작성하는건가요?

Question

학원에서는 시간이 없어서 생략 했던 부분인데메서드마다 기능에대한 정의사를 작성한다고 들었는데 어떻게 하는걸까요?;;찾아봐도 다른 정의서들은 많이 나오는데 메서드 정의서는 못찼겠습니다.컨트롤 서비스 리포지토리 모두 기능마다 다만들어야할까요?findByName(); 이런메서드들의 기능에대한 정의 말입니다.. 알려주세요 ㅠ

집킨 · Answer

요새 그런거 정의하나요...?

동도인 · Answer

메서드 정의가 아니라 API 문서를 말씀하시는거 아닌가요? 아니면 기능정의서? 일거 같습니다

짱구올시다 · Answer

자바독을 사용하시면 됩니다.

카카오콘 · Answer

API 정의서는 익히 사용되지만 메소드 정의서는 처음 듣습니다..?

tired · Answer

기능정의서나 api정의서는 들어봤는데 그건 첨 들어봐용!

장그럴까 · Answer

실무에서 그런거 작성 거의 안합니다.테스트케이스나 요구사항 정의서 같은거정도하고 통합테스트할때 코드인스펙션같은걸로 깔끔하게 정리정도 합니다.화면의 경우 화면정의서에 기능만 정의하구요Api의 경우 코드 정의서 정도 작업합니다.대부분 양식이 있고 ctrl&#43;c , ctrl&#43;v 합니다.-_-;

벼랑끝에서올라오는중 · Answer

걍 javadoc 이용하시면 될거 같습니다. 메서드 정의서를 따로 문서화하는 경우는 못봤습니다.

초무쿤 · Answer

SI 에서 하던 구시대 유물 같은거라고 보시면..물론 지금도 그런거 하는 정신나간곳이 있긴 합니다만 ..;;

장독깨기 · Answer

메서드 정의를 미리 작성하고 개발 진행하는 곳은 거의가 아니라 아예 없습니다.이렇게 까지 하지 않아요. ㅎ다만, 차후에 저런 정의서를 요구할 수도 있는데요, 그럴 경우 주석에서 추출하여 정리 합니다.신경 쓸 필요 없겠습니다. :)

백엔드 개발시 메서드 정의서 어떻게 작성하는건가요?

9개의 답변

기술 목록