在javaDoc中,什么';用XML表示属性的最佳方式是什么?
当您向代码中添加javaDoc注释并概述要传回的XML文档的结构时,表示属性的最佳方式是什么?这方面有最佳实践吗 我的javaDoc注释的一般结构如下:在javaDoc中,什么';用XML表示属性的最佳方式是什么?,xml,javadoc,Xml,Javadoc,当您向代码中添加javaDoc注释并概述要传回的XML文档的结构时,表示属性的最佳方式是什么?这方面有最佳实践吗 我的javaDoc注释的一般结构如下: /** * ... * * @return XML document in the form: * * <pre> * <ROOT_ELEMENT> * <AN_ELEMENT> * <MULTIPLE_ELEMENTS&g
/**
* ...
*
* @return XML document in the form:
*
* <pre>
* <ROOT_ELEMENT>
* <AN_ELEMENT>
* <MULTIPLE_ELEMENTS>*
* </ROOT_ELEMENT>
* </pre>
*/
/**
* ...
*
*@return XML文档的格式为:
*
*
*根元素
*元素
*多元素*
*/ROOT\u元素
*
*/
我不太清楚你的问题
我的首选解决方案是在返回参数的描述中嵌入模式XSD或DTC。您的解决方案似乎引出了关于如何表示多个元素或其他元素的个人习惯用法。使用诸如XSD或DTD之类的标准可以让您拥有一种广为人知且公认的语言来描述XML文档的结构
关于JavaDoc表示,如果您使用的是Eclipse,那么可以在Save Actions下指定文档格式。通过这种方式,您可以使用>和<正常编写,并看到它转换为转义的HTML代码。最后,我使用了:
/**
* ...
*
*@return XML文档的格式为:
*
*
*根元素
*元素属性1属性2
*多元素*
*/ROOT\u元素
*
*/
我的意思是,如果我有一个Java Bean将XML文件返回给JSP,我需要记录该XML文件。如果这有意义的话…可能是
/**
* ...
*
* @return XML document in the form:
*
* <pre>
* <ROOT_ELEMENT>
* <AN_ELEMENT attribute1 attribute2>
* <MULTIPLE_ELEMENTS>*
* </ROOT_ELEMENT>
* </pre>
*/