コメント付加規約

フォローする

複数人によるロボット開発、および長期間にわたるロボットのメンテナンスにおける情報共有や備忘のため、ロボットの構築及び修正においては、必ず以下のルールに従ってコメントを残すこと。

ファイルレベルのコメント

  • ロボット
    • Design Studio の Robot Configuration(ロボットの設定) 内に、当該ロボットの概要を記述すること。

    RobotComment.png

  • スニペット
    • Snippet(スニペット) のDescription(説明) 内に、スニペットの処理概要を記述すること。

    SnippetComment.png

  • タイプ
    • Type(タイプ)のComment(コメント) 内に、タイプの概要を記述すること。

    TypeComment.png

 

要素(Step(ステップ)、value(値))レベルのコメント

  • Step
    • 必要に応じて、Step(ステップ) のBasic(基本) タブ内に当該ステップの処理内容、目的について記述すること。

    StepComment.png
    Step Comment に記述したキーワードはDesign StudioのSearch Boxの検索対象になります。運用開始後のロボットに保守目的で手を加えた際に対象個所を検索する際に便利なので、ロボットの修正時には、必ず 日付担当者 は最低限書き加えること。
    SearchBox.png

  • Attribute(属性)
    • Attribute(属性) に挿入される値の意味は作成者以外には分かりづらく、且つ作成者であっても時間が経過するとその内容・種類を正確に覚えていられない場合もあります。運用後の保守性、ロボットの品質を保つために、Attribute(属性)に挿入される値が直感で分かりづらいものについては、必ずコメントを記入すること。

    AttributeComment.png

0人中0人がこの記事が役に立ったと言っています

コメント

0件のコメント

ログインしてコメントを残してください。