2018/09/17(月) [n年前の日記]
#2 [prog] プログラマーはMarkdownを殺そうとしているなと
Microsoftが提供してる、Visual Studio Code というエディタに、ファイル内の自動整形をしてくれる
_Prettier - Code formatter
という拡張機能をインストールしたのだけど。
導入したら、Markdown文書の見出し行が、
導入したら、Markdown文書の見出し行が、
# 見出しレベル1 ## 見出しレベル2に書き換えられてしまって困ったり。分かってねえな…。
◎ Markdownの売り。 :
以前も書いた気がするけれど…。Markdownの一番の売りは、テキストファイルのまま眺めても文書の視認性が良いという点で。
その一端を示すのが、見出しの仕様。
コレ、どっちが読みやすいか。プログラマーの視点では前者だろうけど、一般人の視点では明らかに後者だよなと。広告メール等でも、よく見かける書き方だし。
プログラマーが「# 見出し」を好む理由は、よく分かる。
しかし、「行頭に『#』があったらそれは見出し行だ」なんてのは、Markdownの仕様を知ってる人しか分からないルールなわけで。
コレが、もう一つの書き方ならどうか。Markdownの仕様を知らない人でも、「アレ? 見た目で区切りがあるぞ…。ははあ、なるほど。これは見出しなわけね」と容易に推測できるよなと。
ルールを知らない人でも文書を眺めれば、なんとなくぼんやりとルールが分かる。それが Markdown の一番の売り。Markdownの価値は、そこにある。
なのに、「# 見出し」を強要してたら、あかんよなと…。ソレ、Markdown って何なのか、そこからして分かってないよな…。
自動化をしやすくしたいなら、あるいは機能を増やしたいなら、Markdown より便利な記法が他にあるわけで。はてな記法だのwiki記法だの、やれることは多いし、処理もしやすいけど、見た目がゴチャゴチャした記法を使ってればええやんか。
_軽量マークアップ言語 - Wikipedia
Markdownの特徴について、分かってるのかなあ…。
その一端を示すのが、見出しの仕様。
# 見出しレベル1 ## 見出しレベル2という書き方の他に、
見出しレベル1 =================== 見出しレベル2 -------------------という書き方も許容されている。
コレ、どっちが読みやすいか。プログラマーの視点では前者だろうけど、一般人の視点では明らかに後者だよなと。広告メール等でも、よく見かける書き方だし。
プログラマーが「# 見出し」を好む理由は、よく分かる。
- 打ち込むのが楽。
- 何かしら自動化しようとした際の判別処理も楽。
- 見出しレベルが1〜6まで変化する際も、「#」「##」〜「######」と同じ記号を増やすだけで対応できるから覚えるのも楽。
しかし、「行頭に『#』があったらそれは見出し行だ」なんてのは、Markdownの仕様を知ってる人しか分からないルールなわけで。
コレが、もう一つの書き方ならどうか。Markdownの仕様を知らない人でも、「アレ? 見た目で区切りがあるぞ…。ははあ、なるほど。これは見出しなわけね」と容易に推測できるよなと。
ルールを知らない人でも文書を眺めれば、なんとなくぼんやりとルールが分かる。それが Markdown の一番の売り。Markdownの価値は、そこにある。
なのに、「# 見出し」を強要してたら、あかんよなと…。ソレ、Markdown って何なのか、そこからして分かってないよな…。
自動化をしやすくしたいなら、あるいは機能を増やしたいなら、Markdown より便利な記法が他にあるわけで。はてな記法だのwiki記法だの、やれることは多いし、処理もしやすいけど、見た目がゴチャゴチャした記法を使ってればええやんか。
_軽量マークアップ言語 - Wikipedia
Markdownの特徴について、分かってるのかなあ…。
◎ プログラマーの悪癖。 :
プログラマーの悪癖として、「何か処理をしたくなると自分達だけが分かる特殊記号を使い始める」とか「打ち込みやすさを優先してしまう」というのがあって。代表的な悪例としては、Perl や正規表現があるのだけど…。
Markdownの見出し文を「# 見出し」で決めつけちゃうのは、その悪癖だよなと。この流れは危ない。このままだと、便利さや処理のしやすさばかり追求して、見た瞬間ゲロ吐きそうなルールを平気で入れ始めちゃう…。そういうのは Perl だの LISP だのでウンザリなんだよ…。
Markdown を扱う時は、テキストのまま眺めてもそれは読みやすいのか、そこを絶えず意識してほしいよなと。
と言っても、巷のアレコレを眺めてると、もう遅い気も…。Markdownに独自仕様が盛り込まれる際、相変わらず謎記号が氾濫するんだよなあ…。Markdownを知った時、「なるほど! 既存の記法とは視点が違う…」と感銘を受けた自分には、ちょっと理解しがたい流れで…。
Markdownの見出し文を「# 見出し」で決めつけちゃうのは、その悪癖だよなと。この流れは危ない。このままだと、便利さや処理のしやすさばかり追求して、見た瞬間ゲロ吐きそうなルールを平気で入れ始めちゃう…。そういうのは Perl だの LISP だのでウンザリなんだよ…。
Markdown を扱う時は、テキストのまま眺めてもそれは読みやすいのか、そこを絶えず意識してほしいよなと。
と言っても、巷のアレコレを眺めてると、もう遅い気も…。Markdownに独自仕様が盛り込まれる際、相変わらず謎記号が氾濫するんだよなあ…。Markdownを知った時、「なるほど! 既存の記法とは視点が違う…」と感銘を受けた自分には、ちょっと理解しがたい流れで…。
◎ 昔は昔で装飾過多だった気もする。 :
考えてみれば…。PC-9801やX68Kを使ってた頃は、ツールの説明書がテキストファイルで書かれてるのが当たり前だったけど、当時、いかにして読みやすい形で書くか、てなあたりも工夫してたよなと。
どこかの時点で、そういう文化がリセットされてしまったのだろうな…。
もっとも当時の、
なんでもそうだけど、バランスが大事だよな…。
どこかの時点で、そういう文化がリセットされてしまったのだろうな…。
もっとも当時の、
■■■■■■■■■■■■■■■■■■■■■■■ ■ hoge fuga piyo 説明書 ■ ■ ■ ■ 19xx.09.17 ■ ■■■■■■■■■■■■■■■■■■■■■■■ ☆☆☆☆ 概要 ☆☆☆☆みたいなのも「おいやめろ」って感じだけど。これはこれで、どことなく「なんでもExcel」文化に近いノリを感じる…。
なんでもそうだけど、バランスが大事だよな…。
[ ツッコむ ]
以上です。