NDoc
From Wikipedia, the free encyclopedia
| NDoc | |
|---|---|
 NDoc 1.3.1 displaying empty project |
|
| Developed by | Downs, Kackman, et al. |
| Latest release | 1.3.1 / 25 January 2005 |
| OS | Cross-platform (?) |
| Genre | Documentation generator |
| License | GNU GPL |
| Website | http://ndoc.sourceforge.net |
NDoc is a code documentation generator for the Common Language Infrastructure. It is licensed under the GNU General Public License.
Contents |
[edit] How it works
NDoc uses two sources to generate a documentation. The first is an assembly file produced by compiling the source code. The other is a pre-generated XML documentation file, usually produced by parsing the source code for special comments (C# compilers from .NET Framework and Mono support this using the "/doc" command-line argument).
The assembly file is queried using reflection to obtain the list of classes, methods, etc. The XML file is parsed for the documentation text.
NDoc supports several different output formats, including CHM, MSDN-style web pages, and Javadoc-style web pages. NDoc also comes with a graphical user interface to ease the generation process.
[edit] Limitations and future development
The latest release version of NDoc does not support .NET Framework version 2.0. Although there are internal alpha versions[1][2] that support .NET 2.0, as of 2006, there is very little activity on the NDoc project. The developer of NDoc, Kevin Downs, has said that he is not working on NDoc anymore due to lack of funding and threats against him, and that he is willing to hand over administration of the project.[3]
[edit] See also
- SandCastle — a new (as of 2006) similar application by Microsoft
[edit] See also
[edit] References
[edit] External links
- Official website of NDoc
- [1] — unofficial port of NDoc to .NET 2.0
- NDoc 2005 and NDoc Reloaded — forks of NDoc
 |
This computer-related article is a stub. You can help Wikipedia by expanding it. |
