코드 주석 – Quarto

Quarto 1.3 Feature

This post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release the download page

Quarto의 코드 블록과 실행 코드 셀에는 이제 줄 기반 주석을 포함할 수 있습니다. 줄 기반 주석은 각주처럼 코드 줄에 설명을 붙이는 방법입니다.

예를 들어 아래 코드는 R dplyr 파이프라인의 단계를 평이한 문장으로 설명하는 주석을 사용합니다.

library(tidyverse)
library(palmerpenguins)
1penguins |>
2  mutate(
    bill_ratio = bill_depth_mm / bill_length_mm,
    bill_area  = bill_depth_mm * bill_length_mm
  )

1: penguins를 가져온 다음,
2: 부리 비율과 부리 면적 컬럼을 추가합니다.

기본 HTML 주석 스타일은 코드 블록 아래 목록에 주석을 표시합니다. 목록에서 주석 번호를 클릭하면 해당 코드 줄이 강조됩니다. 다른 HTML 스타일은 주석을 숨긴 뒤, 사용자가 마커에 마우스를 올리거나 선택할 때 툴팁으로 표시합니다.

PDF 포맷에서도 주석, 번호, 주석 텍스트가 코드 아래에 표시됩니다. Word나 GitHub Markdown 같은 다른 포맷에서는 주석 텍스트가 적용되는 코드 줄(또는 여러 줄) 번호가 함께 표시됩니다.

코드 주석이 표시된 PDF 출력 스크린샷.

``` r
library(tidyverse)
library(palmerpenguins)
penguins |>
  mutate(
    bill_ratio = bill_depth_mm / bill_length_mm,
    bill_area  = bill_depth_mm * bill_length_mm
  )
```

Line 3  
Take `penguins`, and then,

Lines 4-7  
add new columns for the bill ratio and bill area.

코드 블록에 주석을 추가하려면 두 가지가 필요합니다. 코드 셀에 특수 형식의 코드 주석을 달고, 코드 셀 아래에 주석 내용을 담은 번호 목록을 추가합니다.

코드 주석: 코드 셀에서 주석이 달린 각 줄 끝에 (해당 언어의 주석 문자를 사용한) 주석을 붙이고, 공백 뒤에 꺾쇠 괄호로 감싼 번호를 추가합니다(예: # <2>). 주석이 여러 줄에 걸치면 번호를 반복해도 됩니다.
번호 목록: 코드 셀 바로 아래에 번호 목록을 작성하고 각 주석 내용을 포함합니다. 목록의 번호 항목은 동일한 주석 번호가 붙은 코드 줄(또는 줄들)에 대응합니다.

예를 들어 위의 주석은 Quarto 문서에 다음을 포함해 생성했습니다.

```r
library(tidyverse)
library(palmerpenguins)
penguins |>                                      # <1>
  mutate(                                        # <2>
    bill_ratio = bill_depth_mm / bill_length_mm, # <2>
    bill_area  = bill_depth_mm * bill_length_mm  # <2>
  )                                              # <2>
```
1. Take `penguins`, and then,
2. add new columns for the bill ratio and bill area.

주석 스타일을 제어하는 방법과 주석 표시 여부에 대한 자세한 내용은 프리릴리스 하이라이트의 코드 주석 페이지를 참고하세요.