6
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

ソースコードの中でも絵文字を使う 🚀 #進捗を支える技術

Last updated at Posted at 2015-02-07

Gitにおいて、コミットコメントに絵文字を使おうぜ、というものやGitHub issuesでも絵文字表記をする、という話をよく聞きます。一方で本体となるソースコードの中で絵文字を使うという話はあまり聞きません。ソースコードではプログラムには意味をもたないが人間には大きな意味をもつコメントを書けるのですから、通常のコメントとともに絵文字を使うといいんじゃないかな、という話です。

絵文字 emojiの有効性

上記の話の中での絵文字の使用を推奨する理由は、絵文字がテキストと比べてつぎのような特徴をもつためと考えられます。

  • emojiは通常のテキストやテキストから連想できるイメージを反映している
    • :apple: ←これをみて何を考えましたか。多くの人が林檎を連想するはずです
    • 言語の壁を超えた「共通文字」
  • テキストよりも少ない表示領域で、より多くの情報を提供することもできる
    • 例) Hello, world!(テキストでの表示), Hello, :earth_asia:!
  • カラーであることが多く、テキストのみの単色の中でも目立つ

コメントを絵文字で装飾する

通常のテキストのみで書かれたものと絵文字を含めたものを比べてみてください。絵文字の有無以外は同じソースコードです。

好みの問題もありますが、絵文字を含めたソースコードのほうがコメントが、コメントの意味を理解しやすいです。またコメントはファイルの実行時には無視されるものですので、障害にはなりません。

処理ごとに使用する絵文字を統一していれば(画像ファイルとして保存する場合にはコメントで:art:、とか)、絵文字を検索対象とすることでその場所へジャンプすることもできます。

実際に使えそうな絵文字

統計解析などで用いられるRではどのような絵文字が使えそうか、ということを考えてみました。

  • :wrench: -> 設定
  • :package: -> 依存環境、パッケージ(ライブラリ)の読み込み
  • :art: -> 作図
  • :star: -> 必ず必要な処理
  • :ghost: -> 無視しても良い(適宜コメントアウトすべき箇所)
  • :bomb: -> 扱いに注意
  • :construction: -> 改善予定・修正中
  • :white_flower: -> 検定、モデルの実行

注意

かといって、絵文字の多用やコメント内容に沿わない絵文字の使用は混乱や誤解を招く危険があります。ソースコードを書くときの処理内容には、おそらくいくつかのパターンがあると思うので、そのパターンに応じて**使用する絵文字を統一しておく**のが良いかと思います。

絵文字の意味はEmojipediaで調べると良いです。他の環境では絵文字がどのように見えるのかという比較もできます。

というわけでenjoy emoji!

6
7
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
6
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?