Doc-O-Matic - Documentation Web Help

You are here: Interface Components > Settings > General > Editor Options > Documentation Standard

Doc-O-Matic 6

Documentation Standard

Collapse All

Related Settings

XML Options, Javadoc Options, Sections

To add XMLDoc or Javadoc tags

Select [General Settings]Sections.
In the Sections list, select the corresponding section.
Click Edit.
In the XMLDoc box, type the XMLDoc tags you want to use.
In the Javadoc box, type the Javadoc tags you want to use.

Notes

Note that you can use the XMLDoc and Javadoc standard only for inserting comments into natively supported language files. In DTX files only the DTX standard is supported.

Terms

XMLDoc A comment style that is processed by the C# and VB.NET compiler in the .NET framework.

Javadoc A comment style that is processed by the Java compiler.

starters Characters that indicate that a new section starts in Doc-O-Matic.

native language source file A file of a programming language that Doc-O-Matic parses and understands natively. Doc-O-Matic detects and sorts symbols in these files. For example, Delphi, C, C++, C#, VB.NET, Java and ASPX files are native language source files.

DTX file (.dtx file) A file that Doc-O-Matic uses to store comments and topic text. DTX files are also called Topic Files.