[论文解读] 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.

研究动机与目标

• 解决尽管在代码和网页内容中已证明其优势，学术研究论文中仍缺乏语法高亮的问题。
• 通过技术与教学上的论证，反驳关于在学术写作中使用颜色和字体的常见异议。
• 提出一种稳健的基于 LaTeX 的系统，用于对形式符号（如语言定义和逻辑表达式）应用语法高亮。
• 确保语法高亮不会干扰 LaTeX 的排版，特别是在对齐环境和嵌套结构中。
• 确立语法高亮作为更清晰、更易理解的研究交流的标准实践。

提出的方法

• 使用自定义 LaTeX 命令（如 \src{}、\trg{} 和 \blk{}）为源语言和目标语言构造应用不同颜色和字体。
• 定义宏如 \srcletin{}，仅将关键字包裹在颜色命令中，从而在 align* 等环境中保持对齐。
• 使用 \newcommand{\comp}[1]{\blk{\left\llbracket\src{#1}\right\rrbracket}} 安全地将着色表达式嵌入更大的着色文本中。
• 使用 \trgbold{+} 在着色文本中为特定符号应用粗体格式，确保视觉一致性。
• 避免将参数包裹在颜色命令中，以防止数学环境中对齐标记出现问题。
• 对元变量（如源语言中的 P 与目标语言中的 P）应用颜色和字体差异，以在不使用下标的情况下区分语法域。

实验结果

研究问题

• RQ1 语法高亮如何提升研究论文中形式数学与逻辑符号的可读性和清晰度？
• RQ2 在 LaTeX 渲染的学术论文中应用语法高亮的主要技术挑战是什么？
• RQ3 如何在不破坏复杂环境中对齐或排版正确性的前提下，在 LaTeX 中实现语法高亮？
• RQ4 在形式语言定义中，区分语法域的最有效颜色与字体方案是什么？
• RQ5 研究人员如何克服因感知到的技术或审美缺陷而对采用语法高亮产生的阻力？

主要发现

• 语法高亮通过视觉区分源语言和目标语言构造，显著提升了形式符号的可读性，且无需依赖下标。
• 所提出的 LaTeX 宏即使在 align* 等复杂数学环境中，也能实现一致且安全的颜色与字体差异应用。
• 通过仅将关键字包裹在颜色命令中的结构化宏设计，可防止对齐问题并保持排版正确性。
• 为不同语法域使用不同颜色与字体可降低认知负荷，增强读者对形式定义的理解。
• 该方法可无缝集成到现有的 LaTeX 工作流中，无需更改文档类或渲染流程。
• 本文通过具体实现与示例，成功反驳了关于语法高亮的常见异议，证明了其可行性和优势。