[MyBatis] <commnet> - SQL 쿼리에 주석 추가

안녕하세요. 경제적, 시간적 자유를 꿈꾸는 한량입니다.

comment tag 설명

 

<comment> 태그는 SQL 쿼리에 주석을 추가하여

 SQL 쿼리의 의도나 설명을 코드에 포함시킬 수 있습니다.

 

1. <comment> 태그의 구문 및 사용법

<!-- <comment> 태그의 기본 구조 -->
<comment>
    <!-- 여기에 주석 내용을 작성합니다 -->
</comment>

주석 내용은 XML 주석 형식으로 작성하며, 주석 태그 내부에 작성됩니다.

 

2. <comment> 태그의 예제

<select id="getUserById" resultType="User">
    <comment>이 쿼리는 사용자의 아이디를 기반으로 사용자 정보를 조회합니다.</comment>
    SELECT * FROM Users WHERE id = #{id}
</select>

<comment> 태그를 사용하여 쿼리의 의도를 설명하고 있습니다. 

이를 통해 해당 쿼리의 목적이나 사용 방법을 명확하게 이해할 수 있습니다.

 

주석 태그의 장점

1. 코드의 가독성을 향상시킵니다.
2. 다른 개발자들이 코드를 이해하기 쉽도록 도와줍니다.
3. SQL 쿼리의 의도나 사용 방법을 명확히 할 수 있습니다.