Code Formatting Preferences

This tab of the Preferences dialog box is used configure the format of source code that CodeSnip writes to file or copies to the clipboard. The tab is accessed by selecting the Tools | Preferences menu item then clicking the Code Formatting tab.

Source code formatting

Descriptions of snippets can be included as comments in generated source code. The placing of such comments can be customised using the Commenting style drop down list. Options are:

• No descriptive comments – descriptions are not included.
• Comments after snippet header – comments appear between a snippet's header and the body of the snippet. For functions and procedures the header is the function or procedure prototype. For types and constants the comment is placed after the type or const keyword and before any other code.
• Comments before snippet – comments are placed before the snippet. The snippet's name is included in the comment.

Descriptive comments are not applicable to freeform snippets.

A preview of the comment style is displayed below the drop down list.

File formatting

The default format of output files is configurable. The available output types are HTML, rich text and two types of unformatted text, i.e. Pascal files and plain text files. You choose the default output type using the Output file type drop down list.

HTML and rich text file types can be syntax highlighted. To enable this option check the Enable syntax highlighting check box. The highlighting can be customised using the Syntax Highlighter tab.