'문서화 툴'에 해당되는 글 1건

문서화 툴 리스트

개발된 프로젝트의 문서화를 위한 tool 리스트 입니다.
저는 주로 doxygen을 이용합니다만 상당히 많은 documentation tool이 존재하네요..

Documentation Tools

These tools can be used to generate documentation for your code of interest. For keeping documentation optimally linked with source code, we recommend using CodeAssets.

For a more complete website dealing with summaries of documentation tools, code beautifiers, repositories, website organizers, etc., go to CodeOrganizer.com.

Name

Description and Comments

Output

Platforms Supported

Languages Supported

Formatting Codes

AutoDOC

An application to convert specially formatted documentation embedded into tcl code into a cross-referenced set of HTML pages describing this code

HTML

Any platform that runs Tcl (Windows, Unix, Mac)

Tcl/Tk

 

AutoDuck

Created by Microsoft employee but not a Microsoft supported product.

HTML,RTF

Windows

C++, Visual Basic

 

Cocoon

The Cocoon utilities process C++ include files and produce a net of relocatable web pages that document the libraries, classes, and global functions and types that are found in them. Cocoon relies on a small set of simple formatting conventions in the header files.

HTML w/Frames

 

C++

Classes: /*... */
Keywords like HEADING, KEYWORDS, LOG

CcDoc

Created with idea of using same doc standards with java and C++

HTML

 

C++

like javadoc

Cxref

Produces documentation (in LaTeX, HTML, RTF or SGML) including cross-references from C program source code. No plans for a C++ version.

LaTex, HTML,RTF, SGML

Unix, Windows

C

 

cxxwrap

Produces HTML output, JNI (Java Native Interface) headers.

HTML w/Frames, looks most like javadoc 2.0 output of any C++ doc program

Unix, Windows

C++

like javadoc

Cxx2HTML

Written for the AIPS++ project at the National Radio Astronomy Observatory

HTML

Any platform that runs Perl 5

C++

# in comments, Keywords such as <synopsis>, <srcblock>

C2HTML

C2HTML is a software dedicated to maintain C written programs. It runs with DOS/Windows.

HTML w/Frames

 

 

 

Doc++

DOC++ is a documentation system for C, C++, IDL and Java generating both TeX output for high quality hardcopies and HTML output for sophisticated online browsing of your documentation. The documentation is extracted directly from the C/C++/IDL header/source files or Java class files.

HTML w/Frames, LaTex

Linux, Solaris, FreeBSD, AIX, BeOS, HP/UX Windows 95/98/NT/2000,

C, C++, IDL, Java

 

DOxygen

Doxygen is a documentation system for C++, Java, IDL (Corba, Microsoft and KDE-DCOP flavors) and C. Becoming the standard for many Open Source projects (e.g., Mozilla)

HTML. LaTex, RTF, Postscript, PDF, man pages

Unix, Windows

C,C++,Java,IDL

javadoc or QTdoc styles

gtk-doc

For GNOME documentation (GTK 1.2+)

 

 

 

 

HTMLgen

Generates generic HTML documentation

HTML

 

 

 

Javadoc

Java standard set by Sun Microsystems

HTML w/Frames (2.0)

Any platform that runs Java (Windows, Unix)

Java

 

KDoc

KDOC is a C++ and IDL interface documentation tool, initially written for the specific purpose of generating documentation for the KDE libraries. KDOC extracts specially formatted documentation and information about your classes from the class' header or IDL files, and generates cross-referenced HTML, LaTeX or Man pages from it.

 

 

C++, IDL

 

Object Outline

Formerly commercial product from Bumblebee Software, now Open Source. Also outputs software metrics

HTML w/Frames, RTF WinHelp

Windows

C++

 

Perceps

A Perl script designed to parse C/C++ header files and automatically generate documentation in a variety of formats based on the class definitions, declarations, and comment information found in those files.

Mainly HTML, but Tek, RTF, man pages also possible

 

C,C++

 

ReThree-C++

A Reverse Engineering,  Redocumentation and ReUse tool

HTML, RTF

Windows 3.1, Windows 95

C++

 

RoboDoc

Based on AutoDoc from a while back

HTML, ASCII, AmigaGuide, LaTex, RTF

 

Assembler, C, Perl, LISP, Occam, Tcl/Tk, Pascal, Fortran, Shell scripts, COBOL

Uses Keywords in comments and special markers

ScanDoc

ScanDoc is a Perl script which scans C++ source code for specially-formatted comments and produces attractive, organized, indexed documentation.

HTML

Any platform that supports Perl

C++

 

SDoc

SDoc is a general purpose document generator for programmers. It can process files to produce browsable or printable manuals from source files, which can have the documentation embeded in program comments. SDoc is configurable to fit any programming language (almost), and uses a simple markup which is quite readable in source form. Output formats are HTML, LaTeX and Lout.

 

Unix, Windows

 

 

DocBuilder

DocBuilder detects program structures of the languages C/C++ and Pascal/Delphi and also description texts. The latter can be be present in comments inside the program or in separate text files. All relevant information is analyzed, assembled according to the desired configuration to a document and transformed then into the target formats. The user does not have to know these target formats.

HTML, RTF, WinHelp

 

C/C++,Delphi/Pascal

 

DocJet

DocJet is a tool for generating documentation from comments in source code. The current version, 3.0, works with Java, Visual Basic, C, C++ , and MS IDL. There is a full-featured demonstration version available for download. You will probably also be interested in AltHelp, a plug-in for VB and Visual Studio which can display DocJet-generated HTML just like the built-in documentation.

HTML w/Frames

 

Java, C, C++, Visual Basic, MS IDL

 

Genitor Surveyor

From StarBase, who also sells CodeWright, SpyWright, customizable

HTML w/Frames

Windows

C++

javadoc

ObjectManual

A 'javadoc' Like Tool To Generate HTML, MIF, XML, RTF & UNIX "man" Documentation

HTML, RTF, MIF

Unix, Windows NT/95

C++

javadoc style,

TimeToHelp

Generates 'javadoc' style documentation for Delphi source code

HTML w/Frames

Windows

Delphi, Pascal

javadoc style

Together

Enterprise UML modeling tool from TogetherSoft that generates documentation from UML and source code

HTML w/Frames

Windows, Unix

Java, C++

javadoc style

 

 

'개발' 카테고리의 다른 글

Doxygen 및 HTML Help workshop 설치  (0) 2008.06.13
RTLS  (0) 2008.05.21
문서화 툴 리스트  (0) 2008.05.06
자원이 사용중이고 NOWAIT...  (0) 2008.03.25
응용 프로그램을 위한 최상의 사용자 환경을 만드는 방법  (0) 2008.02.26
simpleAdo 2.10  (0) 2008.02.21

Trackbacks 1 / Comments 0

Leave Comments