Markdownの記述でコードブロックの使い方に新しい気付きを得た話。
はじめに
今回は直接プログラミング等の話ではないのですが、ドキュメント作成時などに利用されることの多いMarkdown(.mdのやつ)書いているときにちょっとした便利な使い方を知ったので、それについて備忘録として残します。
今回のは本当に備忘録です。マジで。
コードブロックのコツ
コードブロックと呼ばれる記載法があるんですが、これ自体は割と便利なんですよね。「```」←こんな感じので上下を囲むことでコードを記載すると見やすくなるって話です。
試しに適当に書いてみます。
package ex.output.contentsapp.controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { public String helloworld = "Hello World!"; @RequestMapping("/") public String init () { return helloworld; } }
↑のコードは、Springbootアプリケーション構築の記事を作成した際に作成した処理です。リクエスト処理に対して文字列を返すという内容で、めちゃくちゃ簡単な処理になってます。
これをコードブロック無しで書くとこんな感じになります。
package ex.output.contentsapp.controller;
import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;
@RestController public class TestController {
public String helloworld = "Hello World!”;
@RequestMapping("/")
public String init () {
return helloworld;
}
}
はてなブログが頭いいからなのかなんなのかわかりませんが,class以下は勝手にコードブロックにしてくれました。ただ、どっちみち上のコードブロック内記載と比較すると、見辛いのは事実だと思います。
これまで私がコードブロックを使う時は、上のような使い方をしていました。ところが、今回ある使い方を知ったので、今からその使い方で記載します。
package ex.output.contentsapp.controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { public String helloworld = "Hello World!"; @RequestMapping("/") public String init () { return helloworld; } }
色がついてくれました。
最初のやつより格段に見やすくなったと思います。
これは、```のあとに「java」と入れて記載したため、このような見え方になりました。
コードブロック内にコードを記載する際は、言語を指定すると見やすくなります。
java以外でも試してみましょう。
SELECT * FROM MST_TEST WHERE DELETE_FLG <> 0
SELECT * FROM MST_TEST WHERE DELETE_FLG <> 0
簡単なsqlですが、無いのと有るのとで全然見やすさが違いますね。
終わりに
markdownについては勉強したわけでも調べたわけでもなく、なんとなくで仕事で使っているところから始まっているので、まだまだ知らないことが多いという印象です。
自分で確認するだけならまだしも、誰かに共有するためのドキュメントなどを作成する際は、見やすさも配慮して作れるようになるとベターだと思います。