Bigquery

Bigqueryのコメントアウトの方法は?見やすいコメントアウトの方法も解説

ぐぅ

ぐぅ

京大工学部▶︎京大大学院情報学研究科▶︎日系企業のITエンジニア。研究室ではAI×通信の研究も行いAIにも知見あり。友人とプログラミング初学者向けブログ「はやぶさエンジニア」を運営。ノーコードで企業し、サブスク型サービスを運営。26歳大阪在住

★本記事は5分で読み終えることができます。

【本記事の信頼性】
京大卒の現役エンジニアである筆者がBigqueryのコメントアウトの方法について解説していきます。

未経験くん
Bigqueryのコメントアウトってどうやるの?
コメントアウトってどう使えばいいの。。
未経験ちゃん

このような悩みを解説するための記事になります。

本記事でわかること

  • Bigqueryでコメントアウトする方法
  • 見やすくて分かりやすいコメントアウトを書く方法

Bigqueryでコメントアウトする方法

さっそくコメントアウトする方法を見ていきましょう。

ショートカットはWindowsなら「ctrl + /」、Macなら「cmd + /」です。
(ちなみにこのショートカットはVisual Studio Codeなどのエディターでも同じですよ)

一行をコメントアウトする方法は以下の2つです。

-- コメントアウト 
# コメントアウト

複数行をコメントアウトするには、以下になります。

/*
コメントアウト
コメントアウト
コメントアウト
*/
【動画で勉強したい人必見】Bigqueryを学べるUdemy講座3選

本記事は5分で読み終えることができます。【記事の信頼性】京都大学出身の現役ITエンジニアである筆者は日々の業務でBigqueryを活用しています。Bigqueryを知り尽くした筆者がBigqueryを ...

続きを見る

見やすくて分かりやすいコメントアウトを書く方法

コメントアウトの書き方の通例としてはコメントアウト記号の後に「半角スペース」を入れることです。

あとは正直自由なので、これまでの私のエンジニア経験を元に「見やすいコメントアウト方法」について解説します。

そもそもコメントアウトする目的は以下です。

目的

ソースを書いた人以外の他人が簡単にソースコードを理解し利用できるようにすること


そこで、コメントアウトを書く際は、1年後の自分がソースコードを見て簡単に理解できるように意識して書きましょう。

まずプログラムの最初に以下を記述しましょう。

・どんな処理をするソースか
・開発者や開発日時などメタデータ

例えばこんな感じです。

# 1日単位でアクセスログからデバイスごとのアクセス数を算出する
# 同じディレクトリ内の「data」フォルダを参照する
# 2021-06-01 修正済

関数に関しては以下を記述する。(Pythonの場合で書いてます)

・入力と出力は何か
・どのような処理をする関数か

# 2つの入力値を足し算する関数
# 入力 x int, y int
# 出力 z int
def add(x, y):
  z = x + y
  return z

変数に関しては

・何を表す変数か
・変数の型(ソース内で定義する言語が多いのでケースバイケース)

# アクセスしたタイミングの時刻
access_starttime

# 離脱した時刻
access_endtime

具体的に解説しましたが、目的を意識して必要な情報を書いてください。
後々、苦しむのは自分なので笑

1つ1つ丁寧に作業していきましょう。

まとめ

今回はBigqueryのコメントアウト方法と、見やすいコメントアウトの仕方について解説しました。

未来の自分や、参照してくれる他の人のためにも簡単に理解できるコメントアウトを記述してくださいね!

【動画で勉強したい人必見】Bigqueryを学べるUdemy講座3選

本記事は5分で読み終えることができます。【記事の信頼性】京都大学出身の現役ITエンジニアである筆者は日々の業務でBigqueryを活用しています。Bigqueryを知り尽くした筆者がBigqueryを ...

続きを見る

  • この記事を書いた人
ぐぅ

ぐぅ

京大工学部▶︎京大大学院情報学研究科▶︎日系企業のITエンジニア。研究室ではAI×通信の研究も行いAIにも知見あり。友人とプログラミング初学者向けブログ「はやぶさエンジニア」を運営。ノーコードで企業し、サブスク型サービスを運営。26歳大阪在住

-Bigquery

© 2021 はやぶさエンジニア Powered by AFFINGER5