Slackでコードブロックをマスターする方法

slack コードブロック Slackアプリ活用法

チャットでコマンドやコードを共有したとき、改行や記号が崩れて読みにくくなってしまった――そんな経験はありませんか。今回は、コードを見やすく共有できる「コードブロック」の使い方を解説します。

この記事でわかること

  • インラインコードの書き方
  • 複数行のコードブロックの書き方
  • ツールバーを使った作成方法
  • 活用する上での注意点

結論から言うと、短い単語やコマンドは「バッククォート(`)」1つで囲み、複数行のコードは「バッククォート3つ(“`)」で囲むだけで、見やすいコード表示に変換できます。

1. インラインコード(短い単語・コマンド向け)

文章の中に、コマンド名やファイル名などを目立たせたい場合は、バッククォート1つで前後を囲みます。

`npm install` を実行してください

このように入力すると、「npm install」の部分だけが、灰色の背景を持つ等幅フォントで表示され、文章の中でも見分けやすくなります。

2. 複数行のコードブロック

複数行にわたるコードやログをそのまま共有したい場合は、コードの前後を、それぞれ独立した行にバッククォート3つだけを入力して囲みます。この方法では、改行やインデント(字下げ)がそのまま保持されるため、コードの構造を崩さずに共有できます。

3. ツールバーから作成する方法

バッククォートの記法を覚えなくても、次の方法で同様のコードブロックを作成できます。

  1. コードブロックにしたい文字列を入力(または貼り付け)する
  2. その文字列を選択する
  3. 表示される書式設定ツールバーから、コードのアイコンを選ぶ

4. 色分け(シンタックスハイライト)は非対応

プログラミング用のエディタでよく見られるような、コードの色分け表示(シンタックスハイライト)には対応していません。等幅フォントと背景色による、シンプルな表示のみとなります。

5. 長いログやエラーメッセージの共有に便利

エラーメッセージやシステムログなど、改行や記号が多く含まれる内容を共有する際、コードブロックを使わずに貼り付けると、改行が崩れて読みにくくなることがあります。長い内容を共有する際は、積極的にコードブロックを活用しましょう。

6. スニペット機能との使い分け

さらに長いコード(数十行以上)を共有したい場合は、コードブロックではなく、ファイルとして添付する「スニペット」機能を使う方法もあります。分量に応じて使い分けるとよいでしょう。

7. スマートフォンアプリでの入力方法

スマートフォンアプリでも、バッククォートを使った記法で同様にコードブロックを作成できます。ただし、長いコードの入力には、パソコンからの利用が現実的です。

8. チームでの活用シーン

  • エラーログの共有と、原因調査の相談
  • 設定ファイルの一部を共有し、レビューを依頼する
  • 実行してほしいコマンドを、分かりやすく明示する

まとめ

  • 短い単語はバッククォート1つ、複数行はバッククォート3つで囲む
  • ツールバーからも同様にコードブロックを作成できる
  • 色分け表示には対応していない
  • 長いコードは、コードブロックではなくスニペット機能の利用も検討する

よくある質問(FAQ)

Q. コードブロック内で日本語を使うこともできますか?

はい、日本語を含めても問題なく表示されます。

Q. コードブロックの背景色を変更することはできますか?

背景色は固定されており、個別に変更することはできません。

Q. 一度送信したコードブロックを、後から編集できますか?

はい、通常のメッセージと同様に、編集機能を使って修正できます。

タイトルとURLをコピーしました