[논문 리뷰] Why Should Anyone use Colours? or, Syntax Highlighting Beyond Code Snippets

Marco Patrignani|arXiv (Cornell University)|2020. 01. 28.

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의 타이포그래피 정합성이 손상되지 않도록 문법 강조가 간섭하지 않도록 보장하고자 한다.
• 문법 강조를 더 명확하고 이해하기 쉬운 연구 커뮤니케이션의 표준 관행으로 정착시키고자 한다.

제안 방법

• 소스 및 타겟 언어 구문에 대해 별도의 색상과 글꼴을 적용하기 위해 \src{}, \trg{}, \blk{} 등의 사용자 정의 LaTeX 명령어를 사용한다.
• 정렬 환경(예: align*)에서의 정렬을 유지하기 위해 키워드만 색상 명령어로 감싸는 \srcletin{}과 같은 매크로를 정의한다.
• \newcommand{\comp}[1]{\blk{\left\llbracket\src{#1}\right\rrbracket}}를 사용해 큰 색상 텍스트 내부에 색상이 적용된 표현을 안전하게 삽입한다.
• \trgbold{+}를 사용해 색상 텍스트 내 특정 기호에 굵은 글꼴을 적용함으로써 시각적 일관성을 확보한다.
• 수식 환경에서의 정렬 마커에 문제가 발생하지 않도록 인수를 색상 명령어로 감싸는 것을 피한다.
• 메타변수(예: 소스 언어의 P와 타겟 언어의 P)에 색상과 글꼴 구분을 적용하여 하위첨자 없이도 문법적 도메인을 구분한다.

실험 결과

연구 질문

• RQ1 문법 강조는 학술 논문의 형식적 수학적·논리적 표기법의 가독성과 명확성을 어떻게 향상시킬 수 있는가?
• RQ2 LaTeX로 렲시된 학술 논문에 문법 강조를 적용할 때의 주요 기술적 과제는 무엇인가?
• RQ3 복잡한 환경에서 정렬이나 타이포그래피가 손상되지 않도록 LaTeX에 문법 강조를 어떻게 구현할 수 있는가?
• RQ4 형식적 언어 정의에서 문법적 도메인을 구분하기 위해 가장 효과적인 색상과 글꼴 조합은 무엇인가?
• RQ5 연구자들이 기술적 또는 미적 단점으로 인한 우려로 인해 문법 강조 도입을 거부하는 것을 어떻게 극복할 수 있는가?

주요 결과

• 문법 강조는 하위첨자에 의존하지 않고도 소스 및 타겟 언어 구문을 뚜렷이 시각적으로 구분함으로써 형식적 표기법의 가독성을 크게 향상시킨다.
• 제안된 LaTeX 매크로를 통해 align*과 같은 복잡한 수식 환경에서도 일관되고 안전한 색상 및 글꼴 구분 적용이 가능하다.
• 키워드만 색상 명령어로 감싸는 적절히 구성된 매크로 구조는 정렬 문제를 방지하고 타이포그래피의 정확성을 유지한다.
• 다른 문법적 도메인에 대해 별도의 색상과 글꼴을 사용함으로써 독자의 인지 부담을 줄이고 형식적 정의의 이해도를 향상시킨다.
• 문서 클래스나 렲시 처리 파이프라인의 변경 없이도 기존 LaTeX 워크플로우에 문법 강조를 원활하게 통합할 수 있다.
• 논문은 구체적인 구현과 예시를 통해 문법 강조의 실현 가능성과 이점들을 입증함으로써 일반적인 반론을 성공적으로 상쇄하였다.