문서 생성기

Documentation generator

문서 생성기는 프로그래머(API 문서) 또는 최종 사용자(최종 사용자 가이드)를 위한 소프트웨어 문서소스 코드 파일 세트 및 경우에 따라 이진 파일 세트로부터 생성하는 프로그래밍 도구입니다.Javadoc과 같은 일부 생성기는 특별한 설명을 사용하여 생성 작업을 수행할 수 있습니다.Doxygen은 이러한 모든 방법을 사용할 수 있는 생성기의 예입니다.

생성 유형

문서 생성은 몇 가지 유형으로 나눌 수 있습니다.

  • 배치 생성(일반 기술)
  • 텍스트 블록 대응(사전 정의된 텍스트 블록을 기반으로 작성된 문서)
  • 양식(웹 사이트용 양식)
  • 문서 통합:
    • 문서화는 코드에서[1] 추론할 수 있습니다.
    • 실행[2] 트레이스에서 문서화를 추론할 수 있습니다.
    • 문서는 메일링[3] 리스트에서 추론할 수 있습니다.

일부 통합 개발 환경에서는 문서, 코드 메타데이터 등에 대한 대화형 액세스를 제공합니다.

레퍼런스

  1. ^ Bruch, Marcel; Mezini, Mira; Monperrus, Martin (2010). "Mining subclassing directives to improve framework reuse". 2010 7th IEEE Working Conference on Mining Software Repositories (MSR 2010). pp. 141–150. doi:10.1109/MSR.2010.5463347. ISBN 978-1-4244-6802-7.
  2. ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Automated documentation inference to explain failed tests" (PDF). 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011). pp. 63–72. doi:10.1109/ASE.2011.6100145. ISBN 978-1-4577-1639-3.
  3. ^ Hens, Stefan; Monperrus, Martin; Mezini, Mira (2012). "Semi-automatically extracting FAQs to improve accessibility of software development knowledge". 2012 34th International Conference on Software Engineering (ICSE). pp. 793–803. arXiv:1203.5188. doi:10.1109/ICSE.2012.6227139. ISBN 978-1-4673-1067-3.

「 」를 참조해 주세요.