请输入您要查询的百科知识:

 

词条 Documentation generator
释义

  1. Types of Generation

  2. References

  3. See also

{{refimprove|auto=yes|date=December 2009}}

A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Doxygen or Javadoc, use special comments to drive the generation.

Types of Generation

Document generation can be divided in several types:

  • Batch generation (generic technique)
  • Text block correspondence (documents created based on pre-defined text blocks)
  • Forms (forms for websites)
  • Documentation synthesis:
    • Documentation can be inferred from code[1]
    • Documentation can be inferred from execution traces[2]
    • Documentation can be inferred from mailing lists[3]

Some integrated development environments

provide interactive access to documentation, code metadata, etc.

References

1. ^{{cite journal|last1=Bruch|first1=Marcel|last2=Mezini|first2=Mira|last3=Monperrus|first3=Martin|title=Mining subclassing directives to improve framework reuse|year=2010|doi=10.1109/MSR.2010.5463347|url=https://hal.archives-ouvertes.fr/hal-01575347/document}}
2. ^{{cite journal |last1=Zhang |first1=Sai |last2=Zhang |first2=Cheng |last3=Ernst |first3=Michael |title=Automated documentation inference to explain failed tests |date=2011 |doi=10.1109/ASE.2011.6100145}}
3. ^{{cite journal|last1=Hens|first1=Stefan|last2=Monperrus|first2=Martin|last3=Mezini|first3=Mira|title=Semi-automatically extracting FAQs to improve accessibility of software development knowledge|year=2012|url=https://hal.archives-ouvertes.fr/hal-00681906/document|doi=10.1109/ICSE.2012.6227139}}

See also

  • Comparison of documentation generators
  • Template processor
  • Static code analysis
  • Literate programming
  • Integrated development environment
{{DEFAULTSORT:Documentation Generator}}{{Software-type-stub}}

1 : Documentation generators

随便看

 

开放百科全书收录14589846条英语、德语、日语等多语种百科知识,基本涵盖了大多数领域的百科知识,是一部内容自由、开放的电子版国际百科全书。

 

Copyright © 2023 OENC.NET All Rights Reserved
京ICP备2021023879号 更新时间:2024/11/14 2:48:44