關於 TeeGofer

為 .NET 元件創建説明檔。

TeeGofer is a tool designed specifically for the .NET component writer. Written in 100% native C# code, it works by reflection to read in metadata from .NET assemblies (.DLLs or .EXEs) to create first class quality online help documentation. The tool is extremely easy to work with, presenting a tree navigator of the entire structure of any assemblies selected for the help project. The output quality and ease and speed by which TeeGofer creates component documentation makes it a must for any component help author.

TeeGofer presents the .NET Component Author with unparalleled ease in the creation of Online Component Documentation. Select an Assembly to add to a project, TeeGofer reads it in by reflection, and includes any associated XML summaries to instantly create Microsoft look quality help Topics. The entire Assembly structure is presented in an easy to read Tree format. Navigating through the TeeGofer Tree and selecting the node for any Class, Interface, Property or other Assembly element dynamically creates, for that node, a Help Topic page in HTML, as either HTML Help v1 or HTML Help v2. The Topic page shows the declaration of the element, and auto-creates links to ancestors, variables and returned Types and includes any inline XML code comments as the relevant Summary, Remark or Examples. Page formatting complies with the appearance of Microsofts own Help Topic Pages. Contents of the page may be added to via a Content Editor and links to other pages may be added via a See Also Editor page. TeeGofer automatically creates all member pages and their table contents directly from XML Summaries. TeeGofer supports Custom Content via importation or creation of Custom Topic pages and supports inline URL links, images and editable page header and footer content. Content may be built and compiled for HTML Help v1 and v2 directly from the TeeGofer Tool and includes a Filter Editor and Registration Wizard for HTML Help2 projects. TeeGofer supports inclusion/exclusion of individual Topics or Element branches. Project refresh guards existing content and inserts changes to keep any help file concurrent with its source assemblies.

Specification summary

  • Multiple Assembly support
  • Automatically creates all declarations and relationships
  • Imports /doc compiled Namespace XML summaries
  • Supports XML See, SeeAlso, Example, Params,Code and several other tags
  • Export/import as XML of edited content
  • Treeview access to entire help structure
  • Creates HTML Help v1 and HTML Help v2 output
  • Includes HTML Help v2 Compilation, Registration, Plugin and Filter services
  • Custom Topics
  • Text Editor
  • Table Editor
  • 'See Also' Editor
  • Output Previewer
  • Inheritence and relationships auto-hyperlinked
  • Automatically builds .NET Help2 contextsensitive F1 links
  • Microsoft .Net documentation compliant look
  • Highlights Help Topics devoid of Content and/or XML Summaries
  • Allows for the exclusion of specified help topics to the compiled help file
  • Very fast
  • Inline and URL sourced image support
  • Creates all that is required for built-in F1 links, Index, Search, Dynamic Help Pane and Contents support directly to your .NET component
  • Project refresh protects existing content and maintains the help uptodate with your .NET Component
  • Online help
  • Quick and easy to use
  • No-charge first-level support
  • Commandline utility offers distribution-time registration and plugin of an HTML Help v2 Compiled Helpfile, ideal for use with an Installer file
  • No-charge first level support