Character formats

You can use different character formats for your documentation. These are based on the HTML convention in TwinCAT Documentation Generation.

Bold

You have the option to mark individual expressions in a text in bold. This works by using the <b> markup.

Example:

(*!<description> In the following description, a word is <b>bold</b>. </description>*)

Italic

You have the option to mark individual expressions in a text in italics. This works by using the <i> markup.

Example:

(*!<description> In the following description, a word is written in <i>italics</i>. </description>*)

Code

You have the possibility to mark single variable expressions in a text as code. This works by using the <c> markup.

Example:

(*!<description> The variable <c>iCount</c> is now formatted together with this text block. <code>iCount:=iCount+1;</code> </description>*)

Underlined

You have the option to underline individual expressions in a text. This works by using the <u> markup.

Example:

(*!<description> In the following description, a word is <u>underlined</u>. </description>*)