【コードを資産に】コードのストックにはGoogleドキュメントがおすすめ!おすすめのアドインも紹介します!

Excel

みなさん、こんにちは。
シンノユウキ(@y_stadio)です。

コーディングしていると,同じコードを何度も書くことがあるかと思います.前も同じコード書いたな…と思いつつも,以前のファイルを開くのが面倒で再度書いてしまったりすること,あるのではないでしょうか?(少なくとも私はあります)

そんなことにならないように,以前書いたコードを再利用しやすい環境を構築する必要があります.今回はその環境としてGoogleドキュメントと,Googleドキュメントをコードストックとして利用しやすくするためのオススメのアドオンを紹介します.

ではいきましょう!

 

自分の書いたコードは資産!

自分のコードは理解度も再利用性も高い非常に貴重な財産

株式会社プランノーツ 代表取締役の高橋宣成さんは,自身の著書:『ExcelVBAを実務で使い倒す技術』のなかで上記のように述べています.

元はネットや書籍などに掲載してあったコードであっても,それを自身で咀嚼し,実際に目の前のプロダクトに移植し終えた時には,そのコードは自身の財産となっているはずです.「このコードのこの部分はこういった意味かな?」とか「ここは分かりづらいからちょっと変えてみよう」といった作業を繰り返すうちに,そのコードは最早ネットに落ちていた他人のコードではなく“自身のコード”になっているはずです.

コードをしっかりと自分で理解し,またきちんと動作することも確かめている.こういったコードは自身の財産と呼ぶに相応しいものでしょう.ですので,そういったコードはしっかりとストックしておき,いつでも再利用できるような状態にしっかりと整えておく必要があります.必要な時に利用できない!といった状態を避けるために,いつでもどこでも簡単に利用できるようにしておかなければならないのです.

 

Googleドキュメントがストック集に最適!

コードをストックする環境として,今回は「Googleドキュメント」を紹介したいと思います.ありていに言いますと,後ほど紹介するストック集に必要な要件をある程度満たしているなら何でも構いません.実際,先ほど紹介した高橋宣成さんの書籍では,Evernoteを活用した方法が紹介されています.なので,個人の好みで何を使用しても,特段構いません.

ただ,私は個人的にEvernoteは嫌いです.好きなのは色くらいなもので,何度かヘヴィに使ってましたが,使いこなせませんでした.なので,個人的に好きで,かつストック集として要件を見たしているGoogleドキュメントを今回は紹介させていただきます.

 

ストック集に必要な要件

私がコードのストック集に必要と考える要件は以下の3つです:

  • どんな環境でも利用できる
  • 検索が簡単にできる
  • メモ(ドキュメント)が残せる

です.

ストック集は,職場からも自宅からも,また通勤途中の電車からも見えなくてはなりません.なので,クラウド上で同期できる類のツールを用いるのが便利でしょう.

また,実際にストック集を使用する際には「こういった機能を実装したい」と思い,ストック集を閲覧すると思います.そういった際にはストック集は検索できた方が絶対的に便利でしょう.

さらに,使い方などに関するメモないしドキュメントを残せると使いやすくなります.どういった場面でどのような使い方をすべきか,また使う際にはどような点に注意すべきかなど,コードのコメントでは冗長するぎると感じるようなものでも,残せたほうが便利だと思います.

こういった,私が考えるコードのストック集としての要件を満たすのがGoogleドキュメントでした.

 

シンタックスハイライトも可能!

またそれに加えて,Googleドキュメントではアドオンを入れることでコードのシンタックスハイライトも可能です.実はこれは現時点でEvernoteには無い機能です.Evernoteではコードブロックは挿入できますが,シンタックスハイライトまではできません.不要,という方はぜひ飛ばしてください.

アドオンはこちらになります.

Code Blocks - Google Docs add-on
Syntax highlighting for Google Docs

シンタックスハイライトすることで,コードは以下のように見やすくすることができます:

少し前まではVBに対応していなかったと思うのですが,最近みると対応してましたので,使っています.コードが非常に見やすくなります.

 

まとめ

今回はコードストックに便利なツールとしてGoogleドキュメントを紹介しました.コードストックの方法には色々ありますが,その選択肢の一つになればと思います.