// コメントアウトを普及させたい。あとmarkdown

どうも今回はコメントアウトを普及させたい話です。

// コメントアウトとは

プログラミングなどではコンピュータに無視させたいことがあります。

それは人に向けた情報 です。それをコメントと呼びます。

プログラムのソースコードにはプログラミング言語だけでは表せないこともあるため、人に向けたコードの説明などを記述したりします。しかしそれをコンピュータがプログラムの命令とすることはできないので、コンピュータが無視できるように目印を付けます。それが//となることが多いのです。

ちなみに//は改行まで、/*コメント*/や<!-- -->は囲った範囲までです。

// C#なら
Console.WriteLine("Hello.");
// Hello.
// これが実行されたらコンピュータが読み込むのは2行目だけ。

markdownとは

今回、もう一つ広めたいことにmarkdownがあります。

何を言っているんだと思いますが説明するのでご安心を。

htmlを書いたことがある、理解できるという人向けに補足というか説明。

markdownは簡易的にhtmlを記述するもので、<h1></h1>タグなどを記述せずに# で書ける記法。<b>太字</b>などは**太字**で、<i>斜体</i>は*斜体*のように記述できます。

htmlなんて知るかという人にはこちら。

まず、wordなどで見出しを作るときにアプリのボタンなどで見出しを設定することが多いと思います。これらはwordアプリしか読み取れない目印をつけることで、wordで開いた際に見出しとして大きく表示してます(多分)。

markdownとはそのような目印を本文中に書くことで、ここは大見出しでここは大文字で、などのような装飾や構造化を行える記法です。

装飾とはwordなどで太字にしたり、noteなどで取消線を引いたりする行為です。どちらのツールにもある見出しなども言ってしまえば装飾でしょう。(厳密には文書の構造化などなど、一言では収まらない話もあるでしょうが今回はスルーします)

例えば、noteで大見出しを作る際には、見出しを選択してメニューから、大見出しなどのボタンをクリックする人も多いかもしれませんが、noteもmarkdownの一部に対応しているので、以下のように入力すると勝手にその行が見出しになります。

## 大見出し #の後の半角スペースを忘れずに

#の数によって見出しのサイズが変わり 、数が多いほど見出しサイズが下がります。noteは##と###がそれぞれ、大見出しと小見出しに対応しています。

こうすることで、wordなどの特定のツール専用のファイルではなくただのテキストファイル(所謂プレーンテキスト)でも文書を綺麗に記述できるようになります。

そのほかの通常のマークダウン記法はこちら。

markdownのメリット

あまり説明はしませんが私の感じてるメリットです。

• ソースコードのままでも可読性が高い

• 終タグをあまり意識しない

• 文書をプレーンテキストで構造化できる

• テキストを編集できる環境ならどこでも編集可能

  • wordファイルをテキストエディタで編集するのは多分できない

noteで使えるマークダウン(23/09/07)

sは半角スペースの意味です。

大体最後に半角スペースが必要です。
強調などは記号を二重にして文字を囲みます。ちなみに_も一本に見えますが二本です。

なぜ普及させたい?

何が言いたいかといいますと、上記の二つの記法を日本語でいう「。」の意味ぐらい周知の知識にしたいのです。

もし「##がついてる＝見出し」これが世間に集中されればmarkdownに対応してないツールでも文書を開いても、ここが見出しなんだなとか理解できます。

発表原稿などでは、コメントアウト(//)のメリットを推していて、他人に自分の原稿を読んでもらうときに「ここはこういう趣旨だよ」などの、発話しないけど伝えておきたい説明を極端な話、事前説明無しで伝えられるじゃないですか。

なんと便利な話。事前に打ち合わせしろ

まとめ

今回はコメントアウトとマークダウンを普及させたいという話でした。

正直マークダウンはおまけみたいな気持ちもあって、とにかく//を普及させたいんです。ちなみにnoteでもマークダウンのソースコードを貼り付けることでまあまあ使えますよ。

あとつい最近noteでcmd+sが使えることを知りました。常に押します。cmd+wで誤爆するので。