They are placed right above a function and begin with three ;. For now
they are just for documenting source code, later they are would be parsed for
the api documentation.
Separate return type with the arrow ->.
T V -> U is a function of two arguments of types T and V which returns type U.
Built-in data types (string, integer, float, ...) are in lowercase. Custom ones are capitalized (BufNr, WinID, ...).
-
Arrays or lists are enclosed in square brackets (
[string]- list of strings).[any]- for lists of any type. -
Tuples (multiple value returns) are enclosed in parentheses (used only for return types).
-
Hash tables -
{any}for any type, or specify types with value type{WinID}. -
Functions -
(fn [arg1-type arg2-type] return-type). -
?before the type T means that it could be T or nil (example:?stringcould be string or nil). -
|between two or more types to combine make a sum type (example:string|integercould be string or integer) -
...before the type means variable number of arguments. -
LineNr - positive integer (line number of a buffer)
-
Row - positive integer (row number of a screen)
-
Col - positive integer (column number of a buffer or screen)
-
BufNr - positive integer (buffer number)
-
BufName - string (buffer name)
-
WinID - positive integer (window id, starts from 1000)
-
FileType string filetype of a buffer
Number of ; for comments are the same as in common lisp
- ;;;; - for top-level source file documentation
- ;;; - for function documentation
- ;; - nested comments inside some scope
- ; - for comments at the end of a line
? at the end used for arguments or functions returning boolean value
(example: buf-exists? should answer question Is buffer exists?)
All public function's should have docstrings.