개발어려워
48
2020-02-03 10:36:32 작성 2020-02-03 10:43:04 수정됨
2
718

소스코드 설명서를 어떻게 작성해야하나요?


말 그대로 소스코드를 작성해야합니다

인수인계서를 작성해야되서 소스코드 설명서를 작성해야 하는데

워낙 소스 양이 많아서 문서화하기가 어려운데 특별한 방법이나

간략하게 하는 방법이 있나요?


한글에다가 모든 소스를 cont+c, cont+v 한 다음에 왜 이렇게 했다라고 설명해야하는 건가요?

0
  • 답변 2

  • defult
    9k
    2020-02-03 10:47:09 작성 2020-02-03 10:48:40 수정됨

    게발환경이 어떻게 되있는지는 잘 모르겠느나 설계서 없나요? 사내에 기존 자체 설계서가 존재한다면 자신이 담당한 파트를 그 포멧에 맞춰서 추가하면 소스코드내용에대한 가이드가 됩니다.

    설계서에는 기본적으로 해당 처리 흐름에대한 시퀸스에서 처리 내용의 개요 및 처리에대한 플로어차트등 해당 코드를 이해하는데 필요한건 다 있습니다.


    관련 문서작업에대한 지식이 없으신 상태라면 구글에 “소프트웨어공학 설계서”라고 검색해보세요.

    설계서의 가장 기본이 되는 부분은 소프트웨어공학에서 다룹니다

  • e편한세상
    464
    2020-02-03 11:42:28
    윗분 말씀대로 기존에 설계 문서 양식이 있는지 확인부터 해보세요.

    아니면 인수받을 분에게 어떤형태의 문서를 원하는지 의도를 물어보시구 진행하는게 좋아요.

    단순히 엑셀에 패키지, 클래스, 메소드 나열하고설명을 원하는지  아니면 자바 doc같은 형태를 원하는지 모르잖아요.
  • 로그인을 하시면 답변을 등록할 수 있습니다.