bboydaisuke blog

Just another WordPress site

(Slack) コードを見せる時はスニペットで共有しよう

      2019/08/25

Slack でコードを貼る時は、ただのテキストや画像ではなく、スニペットで送りましょう。スニペットで送ると以下のようなメリットがあります。

  1. 文法に応じて文字に色がつくので、読みやすい
  2. 行番号がつくので、後からコメントする人がコードの位置を指定しやすい
  3. 折りたたむことができるので、スクロールしてコメントを眺める時に邪魔にならない
  4. フォントにソースコード用の等幅フォントが使われるため、読みやすい

逆に、通常のテキストとしてソースコードを貼られると、読みにくいし邪魔になります。画像はもっと良くないです。ソースコードはただ見せられただけではどこが悪いのかわからないことは多々あります。画像で渡されると、質問された人がコードをコピペして実行したり検索することもできません。画像でコードを送るのは、開発環境が表示しているコピペできないエラーを示したいなど、特別な事情がある時以外はやめましょう。

スニペットを作る

まず、次の画像のように、メッセージ入力ボックス左のボタンをクリックして、「コードまたはテキストのスニペット」を選びます。

image

すると、スニペット作成ダイアログが表示されるので、以下のように

  • タイトル(ファイル名など)
  • プログラミング言語の種類
  • スニペットの内容(ソースコード)
  • スニペットに対するメッセージ

を入力します。

image

入力し終わって次のような状態になったら、Create Snippet ボタンを押して送信します。

image

すると次のように、行番号付きの折りたたまれた状態で送信されます。

image

クリックすると展開して内容をすべて見ることができます。展開したものを再度折りたたむこともできます。

最初は自分への DM として以上を試してみるとよいでしょう。

参考
Slack の使い方 > ファイルやメッセージの共有 > スニペットを作成する

 - 未分類