클래스 계층 구조 관리 대장 문서양식
첨부된 "양식 파일" 다운로드 링크는 아래로 내리시면 연관(관련)된 서식 목록 아래 쪽에 있습니다.
소프트웨어 개발에서 중요한 클래스의 구조와 관계를 체계적으로 정리하고 추적하기 위해 필요한 세부 정보를 포함하는 관리 서식으로 클래스명, 부모클래스, 메서드, 생성일, 수정일, 담당자로 구성 되어 있습니다.
클래스 계층 구조 주요항목
작성시 고려사항
클래스 계층 구조 주요항목
- 클래스명: 소프트웨어 시스템에서 정의된 고유한 클래스의 명칭을 명확하게 기재하고 식별할 수 있도록 합니다.
- 부모클래스: 상속 관계에서 현재 클래스의 기본 구조와 특성을 제공하는 상위 클래스를 정확하게 연결하고 표현합니다.
- 메서드: 클래스 내부에서 수행되는 다양한 기능과 동작을 상세하게 기록하고 해당 메서드의 역할을 설명합니다.
- 생성일: 클래스가 최초로 개발되고 시스템에 도입된 정확한 날짜를 기록하여 버전 관리에 활용합니다.
- 수정일: 클래스의 코드나 구조가 변경된 최종 날짜를 명시하여 변경 이력을 추적할 수 있도록 합니다.
- 담당자: 해당 클래스를 설계하고 관리하는 개발자의 정보를 명확하게 기재하여 책임성을 부여합니다.
작성시 고려사항
- 상태 정의: 클래스의 현재 개발 상태와 사용 가능 여부를 명확하게 구분하여 개발 진행 상황을 파악합니다.
- 비고 활용: 클래스와 관련된 추가적인 중요 정보나 특이사항을 상세하게 기록하여 참고 사항으로 활용합니다.
- 이름 표기: 클래스 이름은 개발 표준과 코딩 규칙에 맞게 일관성 있게 작성하여 가독성을 높입니다.
- 설명 작성: 각 클래스의 목적과 기능을 명확하고 간결하게 기술하여 이해를 돕습니다.
첨부파일
