[論文レビュー] Why Should Anyone use Colours? or, Syntax Highlighting Beyond Code Snippets

Marco Patrignani|arXiv (Cornell University)|Jan 28, 2020

User Authentication and Security Systems参考文献 11被引用数 15

ひとこと要約

本論文は、形式的表記（言語構文や数学的式など）に色とフォントの違いを用いた構文強調を広く採用することの重要性を主張する。これは、明確性、簡潔性、正確性を向上させる。本論文は、LaTeXを基盤とした実用的な方法論を提示し、曖昧さを低減し、タイプセットの整合性を損なわずに可読性を向上させる。

ABSTRACT

Syntax highlighting in the form of colours and font diversification, is an excellent tool to provide clarity, concision and correctness to writings. Unfortunately, this practice is not widely adopted, which results in often hard-to-parse papers. The reasons for this lack of adoption is that researchers often struggle to embrace new technologies, piling up unconvincing motivations. This paper argues against such motivations and justifies the usage of syntax highlighting so that it can become a new standard for dissemination of clearer and more understandable research. Moreover, this paper reports on the criticism grounded on the shortcomings of using syntax highlighting in LATEX and suggests remedies to that. We believe this paper can be used as a guide to using syntax highlighting as well as a reference to counter unconvincing motivations against it.

研究の動機と目的

• コードやWebコンテンツでは構文強調の利点が認められている一方で、学術的論文においてはその導入が不十分であるという問題に取り組む。
• 技術的・教育的根拠を提示することで、学術的文書における色やフォントの使用に対する一般的な反論を打ち破る。
• 言語定義や論理式などの形式的表記に構文強調を適用する、堅牢なLaTeXベースのシステムを提示する。
• 特に整合された環境やネスト構造においても、LaTeXのタイプセットに影響を与えないようにする。
• 構文強調を、より明確で理解しやすい研究コミュニケーションの標準的実践とする。

提案手法

• ソースおよびターゲット言語の構文要素に異なる色とフォントを適用するためのカスタムLaTeXコマンド（\src{}, \trg{}, \blk{}）を用いる。
• キーワードのみを色付きコマンドでラップするマクロ（\srcletin{}）を定義し、align*などの環境における整合性を保つ。
• \newcommand{\comp}[1]{\blk{\left\llbracket\src{#1}\right\rrbracket}} を用いて、色付きの式をより大きな色付きテキスト内に安全に埋め込む。
• \trgbold{+} を用いて、色付きテキスト内の特定の記号に太字フォーマットを適用し、視覚的整合性を確保する。
• 数式環境における整合性マーカーの問題を避けるために、引数を色付きコマンドでラップしない。
• メタ変数（例：ソース言語とターゲット言語におけるP）に色とフォントの違いを適用することで、下付き文字を用いずに構文的ドメインを区別する。

実験結果

リサーチクエスチョン

• RQ1 構文強調は、研究論文における形式的数学的・論理的表記の可読性と明確性をどのように向上させるか？
• RQ2 LaTeXでレンダリングされた学術論文に構文強調を適用する際の主な技術的課題は何か？
• RQ3 複雑な環境（特にalign*など）において、LaTeXに構文強調を実装する方法は何か？
• RQ4 形式的言語定義における異なる構文的ドメインを区別するのに最も効果的な色とフォントの組み合わせは何か？
• RQ5 研究者が構文強調の導入に対する抵抗感（技術的・美的な懸念）をどのように克服できるか？

主な発見

• 構文強調により、下付き文字に依存せずに、ソース言語とターゲット言語の構文要素を視覚的に明確に区別できる。これにより、形式的表記の可読性が著しく向上する。
• 提示されたLaTeXマクロにより、align*のような複雑な数式環境でさえも、一貫的かつ安全に色とフォントの違いを適用できる。
• キーワードのみを色付きコマンドでラップする適切なマクロ構造により、整合性の問題が回避され、タイプセットの正しさが保たれる。
• 異なる構文的ドメインに異なる色とフォントを適用することで、認知的負荷が低下し、形式的定義の理解が促進される。
• 本手法により、文書クラスやレンダリングパイプラインの変更なしに、既存のLaTeXワークフローへの構文強調のシームレスな統合が可能である。
• 本論文は、具体的な実装と例示を通じて、構文強調の実現可能性と利点を示すことで、一般的な反論を効果的に反証している。