MADOCHAN BLOG

強いプログラマーを目指す30代のブログ



Slackでmarkdown記法を使って質問をする

最近仕事でもプライベート(サロン)でもSlackを使っています。
Slackとは簡単にいえばチャットです。
サロンで他の方が質問を投げているのを見ていると、エラーの記述を直書きしていたり、スクリーンショットを載せている方がちらほらといらっしゃいます。
それを見るたびにSlackでmarkdown記法が使えることを知ってほしい〜〜!!!!!!と思ってしまいます。
そんなわけでSlackで質問をする際に知っていてほしい書き方を2つ紹介します。

ブロック表示

ブログなどでもある↓こういうのです。

package Test;

public class MainClass {

    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

コードだけでなく、何かしらのエラー表示が出たときもエラー部分をブロック表示させると分かりやすいです。
エラー画面のスクリーンショットを撮って質問する方もみえますが、絶対にエラー記述を一緒に送ったほうが良いです。
なぜなら質問に答えてくださる方もググったり、自身の環境で動かしてみたりするかもしれないから!
スクリーンショットの画像を見てぱっと答えられることならば、そもそもそれは自分で調べて解決できるものでしょうしね。

さらにスクリーンショットの画像はほとんどの場合見にくいことが多いです。
見にくい故に、スクリーンショット画像から検索のためなどでエラーの記述を書き写そうとしても読み間違えするかもしれません。
そうすると写し間違いなのか、エラーなのか分からなくなってしまいます。

質問相手に余分な手間をとらせるのは避けたいところです!

ブロック表示をSlackで使用する方法

ブロック表示をしたいコード等を```で囲むことで、ブロック表示となります。

​```
    コード
​```

引用

引用はこういう表示です。

引用文

本や技術記事など参考にした記述を引用文とすることで、自分の文と引用文を簡単に分けることができ、読みやすくなります。

引用表示をSlackで使用する方法

> 引用文1行のみ

>>>
引用文複数行
(ただし>>>以下はすべて引用文になってしまうので注意)

自分にDMをして確認してみる

ちゃんとインラインコードや引用が使えているか、又は予期せぬところに適用されていないか確認するのには自分へのDM(ダイレクトメッセージ)を使用します。
短い文なら多少記述がおかしくても問題ないですが、長い文だと変な場所でインラインコードが解除されていたり引用がされてしまっていたりすると見にくくなってしまいます。
コピー&ペーストでさくっと確認して、それから相手に送るようにしましょう!