普通のOCRがコードを崩してしまう理由
一般的な文字認識は、文章を読むために作られています。行頭のスペースはノイズとして扱い、ひと続きに見える行はつなげ、目に入った引用符はそのまま出力します。段落ならそれで問題ありませんが、コードでは致命的です。Pythonはインデントが失われると動かなくなり、YAMLは意味が変わり、プレゼン資料のスライドからコピーしたカーリークォートが1つ混じるだけで、文字列が構文エラーになります。
コードモードは、画像を別の方法で読み取ります。
- インデントとスペースを保持します。 1行ずつ保たれるので、入れ子のブロックは入れ子のままです。
- カーリークォートをまっすぐに直します。
“hello”や‘a’は、"hello"や'a'になります。 - 言語名を表示します。 認識できた場合は「Pythonのコードのスクリーンショットのようです」のように表示されるので、モードが画像に合っているかをすぐに確かめられます。
Markdownファイルでダウンロードすると、コードはコードブロック(フェンス)の中に入るので、README、Wikiのページ、メモにそのまま貼り込めます。
ダークテーマと色付きの構文
最近のエディターやターミナルの多くはダークテーマですが、OCRエンジンが最も得意なのは明るい背景の暗い文字です。自動補正は暗い背景の明るい文字を検出し、読み取りの前に反転するので、ダークモードのスクリーンショットも準備なしでそのまま使えます。
色付きの構文も、たいていは問題ありません。弱いのは、テーマの中でコントラストが低い部分です。濃いグレーの背景に置かれた薄いグレーのコメントや、うっすら表示された空白記号などです。そこが崩れて出てくる場合は、グレースケールにしてコントラストを少し上げ、「補正後を表示」に切り替えて、何も消えていないか確認してください。
確認したい文字
多くのコーディング用フォントには、ほとんど同じに見える文字があり、スクリーンショットが小さいとさらに見分けにくくなります。よく間違えられるのは次の文字です。
- 0とO:特に変数名や16進数の値の中
- 1、l、I:フォントによっては1ピクセルしか違わない
- 括弧:
{と(、]と)、それにジェネリクスやHTMLタグの山括弧 - 記号:
;と:、,と.、まっすぐな引用符と読まれたバッククォート - くっついた文字:
rnがmに、clがdに読まれる - アンダースコア:
user_idのような名前で消えたり、スペースになったりする
リガチャ(合字)のあるフォントでは、!=、=>、>=が1つの記号として描かれるため、入力したとおりの文字として読み取られないことがあります。自分のエディターのスクリーンショットなら、撮る前にリガチャをオフにしましょう。
一番手早い確認方法は、リンターやコンパイラーのあるエディターにコードを貼り付けることです。対応の取れていない括弧や紛れ込んだ文字が、数秒で見つかります。
PythonやYAMLのインデントを確認する
インデントが意味を持つ言語では、1段ずれた行でもエラーにならず、ただ違う動きをすることがあります。リンターが必ず気づくとは限らないので、ループの本体や設定ファイルの入れ子のキーなど、重要なブロックはスクリーンショットと入れ子の深さを見比べてください。
結果の行をクリックすると、画像上の対応する位置が光るので、その行が実際にどこから始まっていたかをすぐに確認できます。ブロック全体がずれている場合は、1行ずつ直すより、エディターでブロックごとインデントを調整したほうが早いでしょう。
きれいなスクリーンショットを撮るコツ
あとから文字を手で直すより、スクリーンショットを撮り直したほうが良い結果になることがよくあります。
- 撮る前に拡大する。 文字が大きいほど1文字あたりのピクセルが増え、特に記号の読み取りに効きます。
- コードだけを撮る。 サイドバー、タブ、ミニマップは外し、コードの行にほかのものが混ざらないようにします。
- 折り返しをオフにする。 エディターで2行に折り返された長い行は、2行として読み取られます。
- タブとスペースに注意する。 元のコードがどちらを使っていたかは画像からはわからないので、プロジェクトでタブを使っているなら、貼り付けたあとにフォーマッターをかけましょう。
チャットやエラーダイアログなど、スクリーンショット全般の基本はスクショの文字起こしとスクリーンショットから文字を抽出する方法で紹介しています。コードが長いドキュメントの一部なら、画像をMarkdownに変換で、文章とコードを別々のスクリーンショットに分ける方法を説明しています。