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
| | File | file | files | program | programs | script | scripts | document | documents | doc | docs | header | headers |
| | |
Code Keywords
Class | class | classes | package | packages | namespace | namespaces | record (C# only) | records (C# only) |
Struct | struct | structs | structure | structures |
Enum | enum | enums | enumeration | enumerations |
| 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 |
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.
| Table | table (SQL only) | tables (SQL only) | db table | db tables | database table | database tables |
| View | view (SQL only) | views (SQL only) | db view | db view | database view | database views |
|
Field | field (SQL only) | fields (SQL only) | db field | db fields | database field | database fields | column (SQL only) | columns (SQL only) | db column | db column | database 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 indices | database index | database indexes | database indices | key (SQL only) | keys (SQL only) | db key | db keys | database key | database keys | primary key (SQL only) | primary keys (SQL only) | db primary key | db primary keys | database primary key | database primary keys |
| |
