Keywords

These are the keywords associated with each Natural Docs comment type. They are not case sensitive and are interchangable within their comment type. Using "sub: Multiply" is exactly the same as using "Function: Multiply" so you can use whichever is most natural to you. The plural forms are used for list comments where every item in their definition lists are linkable as if they had their own comment.

General Keywords

Information
topic | topics
| about | list

Group

group |

Section
Ends Scope

section |
| title |

File
Always Global

file | files
| program | programs | script | scripts | document | documents | doc | docs | header | headers

Code Keywords

Class Starts Scope
class | classes
| package | packages | namespace | namespaces | record (C# only) | records (C# only)

Interface
Starts Scope

interface | interfaces

Struct
Starts Scope

struct | structs
| structure | structures

Module
Starts Scope

module (SystemVerilog only) | modules (SystemVerilog only)
| macromodule (SystemVerilog only) | macromodules (SystemVerilog only)

Type

type | types
| typedef | typedefs

Enum
Treated as List Comment

enum | enums
| enumeration | enumerations

Delegate

delegate | delegates

Event

event | events

Function

function | functions
| func | funcs | procedure | procedures | proc | procs | routine | routines | subroutine | subroutines | sub | subs | method | methods | callback | callbacks | constructor | constructors | destructor | destructors

Property

property | properties
| prop | props

Constant

constant | constants
| const | consts

Operator

operator | operators

Macro

macro | macros
| define | defines | def | defs

Variable

variable | variables
| var | vars | integer | integers | int | ints | uint | uints | long | longs | ulong | ulongs | short | shorts | ushort | ushorts | byte | bytes | ubyte | ubytes | sbyte | sbytes | float | floats | double | doubles | real | reals | decimal | decimals | scalar | scalars | array | arrays | arrayref | arrayrefs | hash | hashes | hashref | hashrefs | table | tables | bool | bools | booleans | booleans | flag | flags | bit | bits | bitfield | bitfields | field | fields | pointer | pointers | ptr | ptrs | reference | references | ref | refs | object | objects | obj | objs | character | charaters | char | chars | wcharacter | wcharacters | wchar | wchars | string | strings | str | strs | wstring | wstrings | wstr | wstrs | handle | handles

Database Keywords

Database keywords are prefixed by "database" or "db" to keep them separate, since some like "field" can be interpreted as variables in other programming languages. However, you can use them without prefixes in SQL files.

Database
db | dbs
| database | databases

Table
Starts Scope

table (SQL only) | tables (SQL only)
| db table | db tables | database table | database tables

View
Starts Scope

view (SQL only) | views (SQL only)
| db view | db view | database view | database views

Field

field (SQL only) | fields (SQL only)

db field db fieldsdatabase field database fieldscolumn (SQL only)columns (SQL only)db column db columndatabase column database columns
Cursor

cursors (SQL only) | cursors (SQL only)
| db cursor | db cursors | database cursors | database cursors

Trigger

triggers (SQL only) | triggers (SQL only)
| db trigger | db triggers | database triggers | database triggers

Index

index (SQL only) | indexes (SQL only) | indices (SQL only)

db index db indexes db indicesdatabase index database indexes database indiceskey (SQL only)keys (SQL only)db key db keysdatabase key database keysprimary key (SQL only)primary keys (SQL only)db primary key db primary keysdatabase primary key database primary keys
Next: Scope