sikulixのコードでコメントを書く方法を解説(Jythonの場合の書き方)

sikulixのコードの中にコードの説明を行うコメントを記述する方法について紹介します。

今回のコメントの書き方はsikulixの中で、開発環境がJythonのケースのコメントアウトの方法を解説です。

 

sikulixのコード内容をコメントで説明

コメントとはコードの中で処理のコマンドではなく、処理されない注釈を記述することです。

sikulixのJythonコードにおいて、コメントの記述は非常に大切です。

なぜならば、コードだけを読んで処理の内容を理解するのは難しいからです。

プログラミングのコードを他人が読むのは理解が難しい

自分が書いたコードなら問題ありませんが、sikulixをRPAとして活用している場合、他の人もコードを理解する必要があります。

どういった意図のコードか、コメントで丁寧に説明することが保守性の高い自動プログラムに繋がります。

コメントの書き方は2種類

sikulixでJythonによる開発環境でのコメントの記述方法は2種類あります。

1行コメントアウトする方法と複数行に渡ってコメントアウトする方法です。

1行コメントの場合は「#」

1行だけコメントする場合は、コードの行の先頭に「#(シャープ)」をつけます。

sikulixのJythonでは#(シャープ)を行の先頭に書くと、その行がコメントアウトされる

#(シャープ)を行の先頭に書くと、IDEの画面上で文字の色が変わるのが分かります。

文字の色が変わった行はコメントとして処理され、コマンドが記載されていても実行されません。

複数行コメントは「”’」で囲む

複数行に渡ってコメントしたい場合や、処理の内容を一旦コメントアウト(コマンドをコメントとして処理させなくする)する場合は、半角のシングルクォーテーション3個「”’」で囲みます。

sikulixのJythonで複数行コメントアウトする場合は3個のシングルクオーテーション'''で囲む

囲んだ中の範囲にある記述はすべてコメントして認識されます。

この場合は、IDE上でも文字の色が変化することはありません。

1行のコメントアウトが推奨

sikulixのコメントの記述方法として、どちらが推奨されるかと言えば、#(シャープ)による1行コメントです。

「”’」による複数行のコメントアウトは、文字の色も変化しないため分かりづらい点があります。

さらに、複数のコメントアウトを用いると、どこからどこまでがコメントか把握しにくくなります。

sikulixの複数行コメントはコメントの位置が把握しにくい

1行コメントの場合はそうしたデメリットがないため、コメントを書く場合は#(シャープ)で書くことがオススメです。

まとめ・終わりに

今回、sikulixのJython環境でコードのコメントを書く方法を解説しました。

「#(シャープ)」による1行コメントと、「”'(シングルクォーテーション3個)」で囲む複数行コメントの2種類を紹介しました。

コメントを書く場合には前者の1行コメントが分かりやすくオススメです。

sikulixのコード・プログラムを他の人と共有する場合には、コメントを記述してコードの可読性を高めるようにしましょう。