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

Interface
Starts Scope

interface | interfaces

Struct
Starts Scope

struct | structs
| structure | structures

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
database | databases
| db | dbs

Table
Starts Scope

database table | database tables
| databasetable | databasetables | db table | db tables | dbtable | dbtables

View
Starts Scope

database view | database views
| databaseview | databaseviews | db view | db view | dbviews | dbviews

Field

database field | database fields

databasefield databasefieldsdb field db fieldsdbfield dbfieldsdatabase column database columnsdatabasecolumn databasecolumnsdb column db columndbcolumn dbcolumn
Cursor

database cursors | database cursors
| databasecursor | databasecursors | db cursor | db cursors | dbcursor | dbcursors

Trigger

database triggers | database triggers
| databasetrigger | databasetriggers | db trigger | db triggers | dbtrigger | dbtriggers

Index

database index | database indexes | database indices

databaseindex databaseindexes databaseindicesdb index db indexes db indicesdbindex dbindexes dbindicesdatabase key database keysdatabasekey databasekeysdb key db keysdbkey dbkeysdatabase primary key database primary keysdatabaseprimarykey databaseprimarykeysdb primary key db primary keysdbprimarykey dbprimarykeys
Next: Scope