[JSP][今日のミス] JSP 標準構文のコメントアウトは <%-- ... --%> で

JSF などの JSP の動作確認をしていると、特定の部分だけコメントアウトしたくなることがあります。例えば、一時的に Managed Bean のプロパティを削除した場合などです。

JSP の標準構文（「<% ... %>」形式の構文）を使用している場合、つい以下のようにコメントアウトしがちです。

（；^ω^）何度もひっかかりました。

<!-- <h:outputText value="#{bean.value}" /> -->

しかしこのようにコメントアウトした場合、コメントアウトした（つもりの）部分でエラーが発生することがあります。特に、初めに挙げたような、bean の value プロパティを削除した場合などは確実にエラーになります。

これは、コメントアウトしたつもりの部分を JSP コンテナがコメントと認識していないためです。

実は、JSP の標準構文には「<%-- ... --%>」という形式の標準構文用コメント文が用意されています。このコメント文を使用すると、JSP コンテナがコメント部分をしっかり無視してくれます。

例えば、上の例は次のようになります。

<%-- <h:outputText value="#{bean.value}" /> --%>

JSP コンテナが処理を無視するため、クライアント側からコメントアウト部分は見えません。

なお、JSP を XML 構文で記述している場合は、「<!-- ... -->」のコメント文を使用します。

参考文献

• JavaServer Pages (JSP) v2.0 Syntax Reference - Comment
• The JavaEE 5 Tutorial - Creating a JSP Document