Using XML documentation
XML documentation is useful when you want to autogenerate documentation for your code. If you just put the documentation directly in a triple-slash comment, the entire content will be a summary. The other possibility is to use specific XML tags to specify which type of documentation the specific text belongs to. Doing that enables you, as a programmer, to document the code in a more versatile way.
Useful XML tags
The following are some useful XML tags:
|
Tag |
Description |
|---|---|
|
|
Summary describes code that is commented on |
|
|
Specifies what's returned |
|
|
A remark or something to notice about the code |
|
|
Specifies exceptions that may be thrown from the code |
|
|
Enables you to link your ... |
Get F# for Quantitative Finance now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
