소스 코드 설명 (Callouts)

문서개요

이 문서는 AsciiDoc 에서 소스 코드 설명 (Callouts) 을 표현하는 방법에 대해 설명합니다.

1. Callout syntax

문서에서 설명선(Callouts; Callout numbers)을 표현하기 위해서는 <n>을 사용한다.
<n>는 한 쌍으로 동작하며 첫번째는 소스 코드 블록 내에서 대상이 되는 줄 끝에 배치해야 하고
두 번째는 블록 아래에 배치하고 주석 텍스트를 정의한다.
결과물은 다음과 같다.

1.1. AsciiDoc 소스

Callouts를 작성하는 AsciiDoc 소스는 다음과 같다.

[source,ruby]
----
require 'sinatra' <1>

get '/hi' do <2> <3>
  "Hello World!"
end
----
<1> Library import
<2> URL mapping
<3> Response block

1.2. 결과

Callouts를 사용하는 경우 본문 형태는 다음과 같다.

require 'sinatra' (1)

get '/hi' do (2) (3)
  "Hello World!"
end
1 Library import
2 URL mapping
3 Response block