Comment ノードは、フロー内にコメントやメモを残すためのノードです。プログラムのソースコードにコメントを書くのと同じように、フローの説明、注意事項、TODOなどを記録できます。
📚 本のしおりや付箋に例えると:Comment ノードは本に貼る付箋のようなものです。本文(フローの処理)には影響を与えませんが、読む人に重要な情報を伝えます。
💡 ポイント:
| プロパティ | 説明 | デフォルト |
|---|---|---|
| 名前 | コメントのタイトル(フロー上に表示) | (空) |
| Info | 詳細なコメント内容(Markdown対応) | (空) |
ポイント: フロー全体の目的や概要を記述します。
ポイント: 処理ブロックの区切りとして使用します。
📋 課題: Inject → Debug のフローを作成し、フローの説明コメントを追加してください。
✅ 成功の条件:
フローの左上にCommentノードを配置すると見やすくなります。
📋 課題: 複数のセクションを持つフローを作成し、各セクションにコメントを追加してください。
✅ 成功の条件:
「━━━ セクション名 ━━━」のような区切り線を使うと視認性が向上します。
📋 課題: Markdownを使って、構造化されたドキュメントをCommentノードに作成してください。
✅ 成功の条件:
# や ## を使った見出しが含まれている-)または番号付きリスト(1.)が使われている見出し、箇条書き、番号付きリストを組み合わせて使いましょう。
📋 課題: TODO、バージョン履歴、警告を含むコメント体系を作成してください。
✅ 成功の条件:
絵文字(📚 📋 ⚠️ 📌)を使って種類を区別しましょう。
🎯 重要ポイント:
⚠️ 注意事項:
| 種類 | 配置場所 | 内容 |
|---|---|---|
| フロー概要 | 左上 | 目的、作成者、バージョン |
| セクション区切り | 各処理ブロックの上 | セクションの役割 |
| TODO | 関連ノードの近く | 未実装機能 |
| 警告 | 注意が必要な箇所 | 注意事項 |
担当者、連絡先、変更履歴を明記してスムーズな引き継ぎを実現。
センサー接続情報、閾値設定、トラブルシューティング手順を記載。
実験結果や今後の改善点を記録。
処理の意図や設計判断の理由を記載してレビューを円滑化。