STコメント

コメント	説明	例
単線	マーキングには2つの方法があります。で始まる `//` 行の終わりで終了しますで始まる `///` 行の終わりで終了しますの CODESYS、これらのコメントは同じ方法で処理されます。ただし、ライブラリドキュメントがLibDoc Scripting Collectionを使用して作成されている場合は、以下が適用されます。プロパティが `LibDocContent = DocsOnly` プロジェクト情報に入力され、コメントのみがマークされます `///` ライブラリドキュメントに処理されます。表の下にあるこの例を参照してください。いつ `LibDocContent = CommentsAndDocs` （デフォルト設定）が定義され、すべてのコメントがライブラリドキュメントに処理されます。	`/// This is a comment` `/// This is a comment`
マルチライン	で始まる `(` そしてで終わる `)`。	`(* This is a multiline comment *)`
ネスト	で始まる `(` で終わる `)`。追加コメント `(....)` このコメントに含めることができます。	`( * a:=inst.out; (* comment 1 ) b:=b+1; ( comment 2 ) )`

説明

例

単線

マーキングには2つの方法があります。

で始まる // 行の終わりで終了します
で始まる /// 行の終わりで終了します

の CODESYS、これらのコメントは同じ方法で処理されます。

ただし、ライブラリドキュメントがLibDoc Scripting Collectionを使用して作成されている場合は、以下が適用されます。

プロパティが LibDocContent = DocsOnly プロジェクト情報に入力され、コメントのみがマークされます /// ライブラリドキュメントに処理されます。表の下にあるこの例を参照してください。
いつ LibDocContent = CommentsAndDocs （デフォルト設定）が定義され、すべてのコメントがライブラリドキュメントに処理されます。

/// This is a comment

マルチライン

で始まる (* そしてで終わる *)。

(* This is a multiline comment *)

ネスト

で始まる (* で終わる *)。追加コメント (*....*) このコメントに含めることができます。

( * a:=inst.out; (* comment 1 *) b:=b+1; (* comment 2 *) *)

コメントは、オンラインモードでは変数宣言のコメント列に変数の情報として表示されます。また、マウスポインターを変数の上に置くとツールチップにも表示されます。以下のロジックと優先順位が適用されます

コメントがで始まる場合 /// が変数の前にあると、このコメントが表示されます。
コメントがで始まる場合 // または以内 (**) が同じ行の変数宣言の後にあると、このコメントが表示されます
コメントがで始まる場合 // または以内 (**) が同じ行の変数宣言の前にある場合、このコメントが表示されます

コメントの長さが原因でオンラインモードでコメント全体を表示できない場合は、このコメントフィールドには記号が表示されます。このシンボルの上にカーソルを置くと、コメント全体がツールチップに表示されます

例 79. ツールチップとPOUドキュメントへのコメント

A tooltip in the header of a POU is defined by the following comment:
    // tooltip text – line 1
    // tooltip text – line 2
    // tooltip text – line 3

    Afterwards the documentation is defined as follows:
    /// reStructuredText

メモ:さまざまなコメントタイプを使用して、ライブラリのドキュメンテーションに表示するコメントと、ライブラリ開発者のみを対象としたコメントを制御できます。

このセクションの内容:

STコメント

検索結果