記号を消すツールが、コードブロックの中身だけは触らない理由

AI文章の整形コラム

執筆:松村 誠(植木鉢団 代表)

AIの回答から余計な記号を取り除きたい。
ただし、回答にコードが含まれている場合、同じ扱いをすると困ったことになります。

コードの中の記号は、飾りではなく意味を持っているからです。

消してはいけない記号がある

AIの文章に出てくる記号のうち、消してよいものと、消すと壊れるものがあります。

地の文に付いた強調の記号は、消しても意味が変わりません。読みやすさのために付いているだけだからです。

一方、コードの中では違います。
アスタリスクは掛け算だったり、ポインタだったりします。シャープはコメントの開始だったり、色の指定だったりします。バッククォートは文字列の囲みです。

これらを「記号だから」と一律に消すと、貼り付けたコードが動かなくなります。
しかも、消えたことに気づきにくい。エラーが出て初めて分かります。

見分ける手がかりはフェンス

どこがコードかを判断する手がかりが、コードブロックの囲みです。

バッククォート3つ、あるいはチルダ3つで挟まれた範囲は、AIがコードとして出力した部分です。
その内側は、記号の除去から外します。

Suppinizeでは、処理を始める前にこの範囲を一時的に取り出しておき、記号の除去が終わってから元の位置に戻しています。
記号の除去では、中身に手を加えません。
ただし、見えない文字の除去(ゼロ幅スペースの削除など)だけは、コードブロックの中にも効きます。

囲みの行そのもの(```js のような行)は、地の文には不要なので取り除かれます。

「Markdown記号を除去」をオフにしたときは、囲みの行も含めて、そのまま残します。
番号付きリストや全角・半角の統一をオンにしていても、囲みの内側は対象外です。

閉じの囲みが無いと、コードとして扱われない

Suppinizeがコードブロックと判断するのは、開きの囲みと、同じ記号で開きと同じ数以上の閉じの囲みがそろっている範囲です。
バッククォート3つで開いて4つで閉じるのは構いませんが、開きが4つなら、3つの行では閉じたことになりません。
AIの回答が途中で途切れて閉じの囲みが無い場合や、開きがバッククォート3つなのに閉じがチルダ3つになっている場合も、コードブロックとして扱われません。
その場合、中身も地の文と同じように記号の除去を受けます。

処理後のコードから記号が減っていたら、まず囲みがそろっているかを確かめてください。

インラインのコードは別

同じことが、文中に埋め込まれた短いコードでも起きます。
バッククォート1つで囲まれた部分です。

こちらは判断が分かれます。囲みを残すと記号が残り、消すとコードだと分からなくなる。
渡す先によって正解が変わるので、どちらが良いかは用途次第です。

Suppinizeでのインラインコード

文中のバッククォート1つの囲みは、Suppinizeでは囲みの記号だけを外し、中身を地の文として残します。
ただし、中身はコードブロックのようには保護されません。
「a*b*c」をバッククォートで囲んだものは、アスタリスクの組が強調の記号と同じ扱いで外れ、「abc」になります。

文中に計算式やコマンドを書いた回答では、処理後にその箇所だけ元の回答と見比べておくと安全です。

囲みに入っていないコードは判別できない

この仕組みには限界があります。囲みが無ければ、コードかどうかは分かりません。

AIの回答では、短いコマンドや設定値が地の文にそのまま書かれることがあります。
「設定ファイルに export PATH=... を追記します」のような形です。この部分に記号が含まれていても、囲みが無ければ通常の文として扱われます。

コードを含む回答を機械的に処理するなら、囲みが付いているかを先に見ておくと事故が減ります。
付いていない箇所があれば、そこだけ手で退避してから処理します。

自分で置換するときの注意

ツールを使わず、エディタの置換機能で記号を消す場合、この区別は自動では付きません。

先にコードの部分を別の場所へ退避してから置換し、後で戻す。手作業でも、順番はこれになります。
面倒でも、コードを含む文章では省かないほうが安全です。動かないコードを渡すほうが、記号が残っているより厄介なためです。