Mailing-List: contact user-java-help@ibatis.apache.org; run by ezmlm
Precedence: bulk
Reply-To: user-java@ibatis.apache.org
Received-SPF: pass (athena.apache.org: domain of goetzger@gmx.de designates
 213.165.64.20 as permitted sender)
Message-ID: <47A18EDB.8090403@gmx.de>
Date: Thu, 31 Jan 2008 10:03:23 +0100
From: =?ISO-8859-1?Q?Heinrich_G=F6tzger?= <goetzger@gmx.de>
User-Agent: Thunderbird 2.0.0.9 (X11/20071115)
MIME-Version: 1.0
To: user-java@ibatis.apache.org
Subject: description/documentation/comments in sqlMap
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

Hello,

what is the recommended way or the best practice to add comments and 
documentation into the sqlMap and the containing selects?

Using -- in the select tag is impossible.

Using /* ...*/ is easy, but probably the worst thing. If it is within 
the select-tag it will be handled from the framework as part of the 
select and will be passed to the jdbc code.

Using <!-- ... --> is good. It can be used at every place in the sqlMap. 
But it is not ensuring the connection between comment and sql-code.

So I would like to know if there are other methods or at least ideas for 
some tags/attributes for comment, documentation or description within 
the select-tag?
Using xml-notation based on xsd or dtd would enable further 
xml-processing outside of iBATIS as well.

So, these are just some ideas and I probably missed this already 
existing construct.

Thanks and cheers

Heinrich