XML Comments
From The Oxygene Language Wiki
This is a Language topic
Feel free to add your notes to this topic below.
Xml Comments in Delphi Prism are comments applied to types and members that, when compiled, are placed in an xml file next to the executable or library. Projects that depend on this library can use the xml comments as help for the methods/classes to display in Code Completion. It's also possible to generate a help file or html files from the xml output, using tools like Microsoft Sandcastle. The comments are placed before the to-be documented member using 3 slashes. Sample:
/// <summary>Show a message</summary> /// <param name='msg'>The message to show</param> method ShowMessage(msg: string);
Supported tags:
| | |
|---|---|
| summary | Summary of what this type or member does |
| value | Describes the value a property represents |
| permission cref="membername" | Used to describe the access to this member |
| see cref="membername" | Inserts a reference to a member |
| seealso cref="membername" | Inserts a "see also" reference to another member |
| exception cref="exceptionname" | Describes an exception that members can raise |
| include file="filename" path="xpath" | Includes a subset of another xml file |
| returns | Describes what a member returns |
| param name="name" | Describes a method or array parameter |
| typeparam name="name" | Describes a generic parameter |
| example | Used for example code |
Other tags are possible but the compiler won't validate them. The xml has to be valid (all tags closed).
Area: Oxygene Language
Compiler version: Oxygene 5
Language Glossary — Keywords — Types — FAQ — How To
