Template:APIComment/documentation: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '__NOTOC__<div style="background-color: #DBE9F4;"> ={{Font|Template Documentation|16|Calibri|bold|black}}= This template is for use with the Synthesis API reference documentat…')
 
No edit summary
 
Line 4: Line 4:
={{Font|Template Documentation|16|Calibri|bold|black}}=
={{Font|Template Documentation|16|Calibri|bold|black}}=


This template is for use with the Synthesis API reference documentation only. It is used to display comments in code samples.
This template is a part of a series of templates used as syntax highlighters for the code samples in the Synthesis [[API Reference Documentation]].
 
The other templates in this series are:
*[[Template:APIPrefix]]
*[[Template:APIString]]
 


==Usage==
==Usage==
Here's an example of how to use the template:
Here's an example of how to use this series of templates:
<pre>{{APIComment|'This is a code comment.}}</pre>
<pre>{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})</pre>


The output is displayed as follows:
The output is displayed as follows:
 
<div style="background-color: #E6E6E6;">
{{APIComment|'This is a code comment.}}
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}<br>
 
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository <br>
 
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
</div>





Latest revision as of 16:42, 5 May 2016


Template Documentation

This template is a part of a series of templates used as syntax highlighters for the code samples in the Synthesis API Reference Documentation.

The other templates in this series are:


Usage

Here's an example of how to use this series of templates:

{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})

The output is displayed as follows:

'Declare a new Repository object and connect to a Synthesis repository.
Dim MyRepository As New Repository
MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")