User:Blue.painting/LibreOffice macro documentation standards

This page tries to enumerate some various standards related to LibreOffice macro documentation. They are based mostly on LibreOfficiant's conventions, as well as some of mine.

Misc

 * Variable names should always be in English
 * Use 4-space indent, not tab
 * Capitalize special words, for example  and not
 * All subroutines and functions should have a description, also an indication of sub/func name after the end, as shown here:
 * Always specify  at the top of the code, which forces type declarations for objects and variables.
 * Always specify API object path as comment when declaring objects, such as in the following example:
 * Always specify API object path as comment when declaring objects, such as in the following example:

Comments

 * Comments should always be surrounded by tags
 * Do not use  but rather use   (with a space after it before the comment)

Dialogs

 * If have dialog such as, the messages should be surrounded by tags
 * If an example ODT file is included, use L10N extension where a dialog handles localization (l10n) of different languages.

Page subheadings

 * The page should include subheadings Description, Code, and Notes (with the ), and possibly an Example ODF file to test macro.