javaDoc에 샘플코드(xml 등) 작성하기

javaDoc에서 샘플코드를 작성할 때 아래처럼 바로 쓰면 문서상에서 보이지 않는다.

/**
 * Transaction 처리를 위한 DataSourceTransactionManager를 지정한다. <br>
 * transactionManager bean은 아래와 같이 정의해서 사용한다.
 * <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
 *     <property name="dataSource" ref="dataSource" />
 * </bean>
 * @param transactionManager
 */
public void setTransactionManager(DataSourceTransactionManager transactionManager) {
    this.transactionManager = transactionManager;
}

이때 <pre>와 @code 태그를 사용하면 해결된다. 샘플코드 자체는 @code 태그만으로도 작성이 가능하지만, 완성된 문서에서는 개행이 안 되어 있기 때문에 HTML의 <pre> 태그를 함께 사용한다.

/**
 * Transaction 처리를 위한 DataSourceTransactionManager를 지정한다. <br>
 * transactionManager bean은 아래와 같이 정의해서 사용한다.
 * <pre>
 * {@code
 * <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
 *     <property name="dataSource" ref="dataSource" />
 * </bean>
 * }
 * </pre>
 * @param transactionManager
 */
public void setTransactionManager(DataSourceTransactionManager transactionManager) {
    this.transactionManager = transactionManager;
}