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

 

词条 NDoc
释义

  1. How it works

  2. Limitations and future development

  3. See also

  4. References

  5. External links

{{distinguish|NDOC (disambiguation)|Ndoc}}{{Infobox software
| name = NDoc
| logo =
| screenshot = NDoc 1.3.1.png
| screenshot size = 200px
| caption = NDoc 1.3.1 displaying empty project
| latest_release_version = 1.3.1
| latest_release_date = 25 January 2005
| developer = Diamond, Manoli, et al.
| operating_system = Cross-platform (?)
| genre = Documentation generator
| license = GNU GPL
| website = {{URL|http://ndoc.sourceforge.net/}}
}}

NDoc is a code documentation generator for the Common Language Infrastructure created by Jason Diamond, Jean-Claude Manoli and Kral Ferch. It is licensed under the GNU General Public License.

How it works

NDoc uses two sources to generate 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 uses plug-ins to support several different output formats, including CHM, Microsoft Help Viewer, MSDN-style web pages. Incomplete plug-ins are also included as starting points for developers, like the LaTeX plug-in and Javadoc-style web pages. NDoc comes with a graphical user interface to ease the generation process.

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|lc=on}}, 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]

More recently, Kim Christensen picked up the ball and continues development of the original NDoc as NDoc3[4]

See also

{{Portal|Free and open-source software}}
  • Doxygen - a mature document generation tool that can also build class diagrams and produce documentation from many other languages.
  • Sandcastle — a similar application by Microsoft.
  • Sandcastle Help File Builder — a freeware GUI front-end for Sandcastle that provides Ndoc-like features.
  • Visual Expert - a documentation generator that also provides call trees, CRUD matrix, impact analysis, code review for PL/SQL, Transact-SQL and other languages.
  • Comparison of documentation generators

References

1. ^NDoc project stalled, no version for 2.0. What is Microsoft doing? - Fabrice's weblog
2. ^NDoc 2.0 Alpha
3. ^[https://web.archive.org/web/20060819173307/http://johnsbraindump.blogspot.com/2006/07/ndoc-20-is-dead.html John's .NET/SQL Brain Dump: NDoc 2.0 is Dead!]
4. ^NDoc3, successor project of NDoc

External links

  • Official website of NDoc
  • Website of NDoc3, official successor to NDoc
  • NDoc 2005 and NDoc Reloaded — forks of NDoc
{{DEFAULTSORT:Ndoc}}

1 : Free documentation generators

随便看

 

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

 

Copyright © 2023 OENC.NET All Rights Reserved
京ICP备2021023879号 更新时间:2024/11/16 8:15:20