XML注释:使用或不使用？
在软件开发中，XML注释是一种将文档信息添加到源代码中的方法。它们可以帮助其他开发人员了解代码的功能和用途。XML注释的使用取决于项目的需求和团队的编码规范。
优势：
- 提高代码可读性：XML注释可以帮助其他开发人员更好地理解代码的功能和用途。
- 提高团队协作效率：通过添加XML注释，开发人员可以更快地了解代码的工作原理，从而提高团队的协作效率。
- 方便代码维护：当代码需要进行修改或维护时，XML注释可以帮助开发人员快速了解代码的结构和功能，从而提高代码维护的效率。
应用场景：
- 在函数、类和方法中添加XML注释，以解释它们的作用和用途。
- 在代码中添加XML注释，以解释复杂的算法或逻辑。
- 在代码中添加XML注释，以解释与其他模块或函数的交互方式。
推荐的腾讯云相关产品和产品介绍链接地址：
- 腾讯云开发者实践：https://cloud.tencent.com/developer/practice
- 腾讯云云服务器：https://cloud.tencent.com/product/cvm
- 腾讯云数据库：https://cloud.tencent.com/product/cdb
- 腾讯云存储：https://cloud.tencent.com/product/cos
- 腾讯云移动应用：https://cloud.tencent.com/product/tmt
- 腾讯云物联网：https://cloud.tencent.com/product/iot
- 腾讯云人工智能：https://cloud.tencent.com/product/ai
- 腾讯云区块链：https://cloud.tencent.com/product/tbaa
- 腾讯云元宇宙：https://cloud.tencent.com/product/metaverse
相关·内容
我将我的项目导出为runnable jar，并在java 8环境中执行。但我得到了
org.xml.sax.SAXNotRecognizedException: http://javax.xml.XMLConstants/feature/sec
ure-processing
at org.apache.xerces.parsers.AbstractSAXParser.setFeature(Unknown Source
)
at org.apache.xerces.jaxp.SAXParserImpl.setFeatures(Unknown Source)
浏览 18提问于2017-03-10得票数 0
1回答
我试图创建一个JAX服务，它允许将原语、映射和列表的混合值作为映射和列表的值。域模型中的所有属性都不能具体定义，因为数据将来自不同的系统，其中一些属性将存在，而另一些则不存在。该服务需要同时支持XML和JSON。JSON结构需要类似于下面列出的结构，而不需要由于包装类而对元素进行额外嵌套。XML结构尚未设置，而且更具可塑性。
到目前为止，我一直在使用Resteasy和Jackson，并且一直回避特定于供应商的注释，但是我意识到这可能是不可避免的。这些服务API没有被锁定，我愿意接受其他可以实现这一目标的建议。一个要求是这是一个标准的REST服务。
表示项目的示例对象：
@XmlAccessor
浏览 1提问于2013-07-19得票数 1
当我试图在eclipse中从jaxb类生成模式时，我将面临以下错误。从下面的错误中，我能够理解问题在于jaxb类中的注释之一。
但是，从下面的错误中，很难找到jaxb类引起错误的注释。
有人能建议如何调试这个问题吗？
错误：
！装.！
!com.XX.XXX.utils.Pageable!
!com.XX.XX.utils.MetaData!
!com.xx.xxx.utils.Page!
Exception in thread "main" java.lang.ArrayStoreException: sun.reflect.annotation.Enu
浏览 3提问于2016-12-13得票数 0
回答已采纳
当XmlParser报告不允许在xml注释中使用两个连字符(--)时，我在配置文件的xml注释中应用了标记注释。
在检查XML规范时，由于与SGML解析器的兼容性原因，xml似乎没有被设计为包含两个连字符。
为什么SGML解析器在注释中不允许双连字符？
浏览 0提问于2013-05-17得票数 24
回答已采纳
当RESTeasy将POJO编组到XML时，默认情况下它会跳过空值:参见。
但是，当编组到JSON时，将包含空属性。有没有办法强制JSON输出与XML输出匹配？
浏览 0提问于2011-11-01得票数 5
我想在hibernate实体中声明一个瞬态方法，我们使用hbm.xml文件来实现映射，而不是注释。
我在网上很少看到有人在xml中声明字段瞬态，用注释声明方法瞬态，但我找不到在xml中声明方法瞬态的文档。我看到有人提到，如果它不在hbm.xml文件中，Hibernate将忽略它，但我想确认一下。
这方面的文档在哪里？
浏览 0提问于2019-08-13得票数 0
回答已采纳
4回答
这只是一个不能错过的验证。
/n在XML中没有行注释吗？所以，一个没有闭合的，比如编译器使用的"//“。
我看到了和其他几个讨论。
这种类型的注释对于注释掉一行代码而不影响它的下一步是很实用的。
浏览 147提问于2013-06-27得票数 130
回答已采纳
3回答
如何在“请勿编辑此文件”注释后添加换行符？我尝试添加带换行符的textnode，但它不起作用。
代码：
import java.io.File;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import ja
浏览 7提问于2012-08-05得票数 5
在XML文件中将注释放在XML声明之前可以吗？
<!--
Is this bad to do?
-->
<?xml version="1.0" encoding="utf-8"?>
<someElement />
浏览 7提问于2009-07-28得票数 31
回答已采纳
1回答
我在2010中添加了一个驱动程序引用(.dll)。但问题是，intellisense文档缺少(也是对象浏览器)注释。当我转到程序集位置时，会看到带有文档的XML文件。为什么MS Visual找不到XML文档？
浏览 1提问于2014-03-17得票数 1
我目前正在将hibernate配置为使用ehcache并以编程方式提供CacheManager。我们不使用hibernate.xml或ehcache.xml，因为我们有自己的配置服务来提供此类信息。
现在我面临一个问题:必须以编程方式在哪里定义配置cache usage？
如果可能的话，我想在创建CacheConfiguration时激活它，但我找不到允许设置该属性的方法。
提前感谢
浏览 2提问于2012-10-27得票数 0
回答已采纳
我在Azure的Tomcat容器上部署遇到了问题。我用FTP连接到创建的web应用程序空间，将war文件复制到正确的文件夹中。
myWebApp
我已经成功地在Azure上部署了一个Spring简单web应用程序。URL模式如下所示，这两种模式的工作都如出一辙：
http://myWebApp.azurewebsites.net/myWebApp部署在Azure Tomcat上
部署在本地Tomcat上的http://localhost:8080/myWebApp
下面的密钥文件是web.xml：
<web-app ... xsd schemas ... >
浏览 1提问于2017-01-25得票数 1
回答已采纳
我正在寻找Hibernate注解或.hbm.xml，它们允许我将表列指定为不区分大小写的字符串，以独立于unicode/utf-8/locale的方式工作，可以在多个数据库引擎上工作。
有没有这样的事情？
这样我就可以高效地使用Restrictions.eq("column_name", "search_string")进行查询。
浏览 0提问于2009-10-12得票数 1
回答已采纳
1回答
我正在为Android编写一个API客户端库，并使用简单的XML对对象进行反序列化，因为JAXB似乎不能在Android上工作。
API项目中的类具有针对JAXB的XML注释。我将这些类复制到我的Android库中，但将XML注释更改为简单的XML。显然，这会在同步更改时产生问题。
有没有办法使两者兼容，使相同的代码可以与JAXB和简单的XML一起使用？
浏览 0提问于2011-07-15得票数 3
回答已采纳
1回答
我正在学习Security，并跟踪。
我下载了这个项目，没有任何问题。另外，我可以打包它的.war文件，并将这个包部署到另一个Tomcat服务器上。
我有点困惑，因为项目中没有web.xml文件。实际上，除了pom.xml之外，没有任何xml文件。我认为我们也可以在Spring中使用Java文件进行配置。
最后，我想了解这个xml文件。为什么Spring的配置结构中没有web.xml文件？
浏览 3提问于2015-09-28得票数 1
回答已采纳
1回答
这是一个关于Visual中的XML注释的问题。
我有一个实现接口的类。当我将XML注释放在实现接口的方法上时，智能中的XML注释使用的是来自接口的方法，而不是实现的方法。如果我从接口方法中删除注释，智能就不会显示任何注释。有什么方法可以让智能来使用实现方法中的注释而不是接口方法吗？
浏览 0提问于2013-12-11得票数 2
回答已采纳
2回答
<context:annotation-config/>
<context:component-scan...
它用于我需要用@Repository @Service @Component注释的类...
<context:spring-configured />
<context:component-scan...
如果我需要使用@Configurable，请使用
<tx:annotation-driven transaction-manager="transactionManager" />
<cont
浏览 1提问于2009-12-25得票数 2
回答已采纳
在我正在进行的一个项目中，由于私有成员变量上缺少Javadoc注释，checkstyle失败了。对我来说，这似乎是不必要的严格行为，我想通过一个抑制XML文件来抑制私有成员的错误。
以下文件成功地抑制了变量上的所有校验风格的Javadoc错误：
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_
浏览 2提问于2015-04-27得票数 3
我正在开发一个JPA应用程序，它需要能够访问同一个数据库(即DB2/Oracle)上的不同模式。我希望我的所有实体都在persistence.xml文件(<class>)中注册，并能够定义哪些实体属于某些模式。
我知道可以使用java注释，但是这是一个需要最终用户相应配置的产品(因此我希望能够在xml文件中实现这一点)。
目前，我发现了这样一个例子：
orm.xml
<?xml version="1.0" encoding="UTF-8"?>
<entity-mappings xmlns="http://java.sun
浏览 1提问于2016-05-16得票数 0
我正在使用DocumentBuilder将包含"--“注释的xhtml(xml)从互联网转换为org.w3c.dom.Document。有没有可以绕过它的方法？我已经设置了setIgnoringComments和setValidating。
我知道-不允许在W3C规范中的XML注释中出现。。
对于在约定之前对XML进行预处理有什么建议吗？
public static Document convertXmlStrToDocument(String xml) throws ParserConfigurationException, SAXException, IOException{
浏览 1提问于2016-12-12得票数 0
回答已采纳
1回答
Jaxws和MTOM似乎不起作用
、、、、
我想使用MTOM通过Webservice (jaxws)发送docx文档。
以下是我的wsdl的摘录：
<xsd:element name="createDocumentResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="docContent" type="xsd:base64Binary" />
</xsd:sequence>
</xs
浏览 3提问于2015-04-28得票数 1
我试着编写了一个简单的Hibernate 3 java程序--为了从DB中获取数据，当我尝试使用hbm.xml文件进行配置时，它工作得很好，但是当我使用模型类配置相同的数据时，我将面临如下问题。即
<mapping class="example.Pojo_Stock"/>
而不是
<mapping resource="Pojo_Stock.hbm.xml" />
虽然在堆栈溢出(许多标记为重复)上尝试了所有相关查询，但无法找到解决方案。请帮帮忙
public class MainApp {
private static Se
浏览 3提问于2016-04-19得票数 0
嗨，我是spring的新手。我正在使用注解。我的怀疑开始了，我有一节课
public class MyClassA{
@Autowired
private MyClassB variableClassB;
// more code here
.
.
.
在我的applicationContext.xml
<context:component-scan base-package="package containing MyClassB" />
我的问题是，我是否需要在applicationContext.xml中添加bean声明，如下所示
<bean id=
浏览 0提问于2013-07-15得票数 6
回答已采纳
1回答
我意识到这个问题被问了无数次，但似乎没有一个解决办法适合我的情况。
我有一个基本的Spring应用程序，我准备了一个servlet上下文。我可以看到，@Component注释类和属性文件都是在启动时获得的，如下所示。但是，我的@Value注释字符串将返回为null。
，有人认为我的设置有什么问题吗？请随时询问我可能遗漏的任何其他信息。
未来的，我能用什么最好的方法来调查我将来遇到的问题呢？
directmail-manager-servlet.xml:
<?xml version="1.0" encoding="UTF-8"?>
&l
浏览 1提问于2014-04-23得票数 0
回答已采纳
我有一个简单的hibernate示例，它有一个实体类。我在entity类中添加了一个字段，我不想在数据库表中为该字段创建列。我该怎么做呢？
我的实体类：
@Entity
@Table(name = "person")
public class PersonEntity {
private Long id;
private String emailEntity;
private String nameEntity;
private String familyEntity;
private String cityEntity;
private String phoneEntity
浏览 1提问于2015-01-21得票数 2
我将编辑器从RAD7.5升级到8，将maven 2升级为3。这种情况发生在导入RAD 8中的现有maven项目之后，但我在任何pom文件上都没有错误。
问题在于两个xml文件：
包含版本部署描述符的项目需要XMI格式的绑定或扩展文件。ibm-web-bnd.xml /DocViewerWeb/WebContent/WEB未知验证消息
包含版本部署描述符的项目需要XMI格式的绑定或扩展文件。ibm-web-ext.xml /DocViewerWeb/WebContent/WEB未知验证消息
这两个文件的内容如下：
<?xml version="1.0" encoding=&
浏览 1提问于2012-04-20得票数 8
回答已采纳
我有一个POJO，我想将它注入到CDI中。现在，我可以将beans.xml中的发现模式从“带注释的”更改为“all”。但是我也可以给我的POJO一个bean定义注释。我想任何注释都会起作用，但我想知道，什么是正确的注释，仅仅是为了使我的POJO可注入的唯一目的？
浏览 4提问于2016-06-16得票数 1
回答已采纳
哲学问题：
我想到的一个问题是，特别是在使用像Spring或Hibernate这样的框架(在工业中无处不在)时，我们已经注释了所有的东西。
这显然比声明性XML语句更好..。但这也意味着我们正在进行声明式编程，因为引擎(框架)正在为我们做一些事情。引擎本身可能是用Java (OOP)编写的，但我们实际上是使用声明进行编程。
例如，@Autowire --在这里注入我的组件，我不在乎你是怎么做的，也不在乎后台发生了什么。
那么，这是通过注释异端来实现的吗？还是与使用配置文件(XML和属性)相同。
背景信息：
“Java中的声明式编程”- http://www.onjava.com/pub/a/o
浏览 0提问于2016-03-31得票数 2
回答已采纳
我正在尝试使用语言注入来启用phpstorm中特定于okckout.js的代码突出显示。到目前为止，我能够在data-bind XML属性中做到这一点，这是非常简单的：
但是我想不出如何为<!-- ko: --> <!-- /ko -->的敲除风格的评论创建一个注入
在php storm中有一个通用的xml注入，但我不知道在“patterns”部分中放什么：
浏览 5提问于2015-08-10得票数 14
回答已采纳
我们的项目在XML文件中有数百条注释。其中有些只是像这样的分隔器：
<!--
==============================================================================================
Entity Manager Bean
==============================================================================================
-->
我们广泛地使用XML自动格式化程序，它总是保持行分开，同时
浏览 4提问于2010-11-20得票数 1
我只想知道android(Java/XML)代码中的注释是否会影响APK的大小？
示例：-
/*ActionBar actionBar = getSupportActionBar();
actionBar.setDisplayHomeAsUpEnabled(true);*/
浏览 1提问于2015-08-26得票数 4
在我的web服务中，我希望返回依赖于客户端请求的对象集合，例如(字符串集合、自定义类.)，我的代码：
@XmlRootElement(name="ResultObject")
public class ResultObject
{
private Object _Contents; // this object should contain the collection
private int _ErrorCode;
.....
}
但是，当试图返回字符串的ArrayList或数组时，会出现以下异常：
2012年12月30日5:49:21下午5:49:21 com.sun
浏览 3提问于2012-12-30得票数 0
我使用Doctrine 2作为Symfony框架中的ORM。使用基于注释的实体映射，我必须编写大量代码(setter和getter，映射信息等)。使用YAML/XML，我不必编写太多内容，只需编写列定义和元数据即可。在Doctrine文档中，它们主要在示例中使用注释，很少使用YAML或XML。
我应该使用YAML/XML还是注解？
对于批注，我可以在上找到每个批注的文档。但是，我在YAML或XML中找不到等价的批注；如何将批注转换为等效的YAML/XML表达式？
浏览 2提问于2012-09-21得票数 11
回答已采纳
我编写了一个简单的gedit xml lang文件来突出显示源代码。当我使用像这样的结构
<style id="comment" _name="Comment" map-to="def:comment"/>
<style id="keyword" _name="Keyword" map-to="def:keyword"/>
它总是注释为蓝色，关键字为棕色。相反，我希望我的评论是绿色的，关键字是红色的。我该怎么做呢？
我还注意到/usr/share/gtksourceview-
浏览 2提问于2012-11-11得票数 2
1回答
我需要使用java在xml文件中编写<name> Dolce & Gabanna </name>。但是，生成的是<name> Dolce & Gabanna </name>。
有什么方法我可以在java中使用，这样"&"就可以用xml显示，而不是"&"。
谢谢。
浏览 1提问于2015-06-25得票数 0
回答已采纳
2回答
JBOSS注释
、、、、
背景
我正在尝试使用SOAP和JBOSS制作一个and服务。我知道，要创建一个you服务，您可以这样做：
import javax.jws.WebService;
@WebService
public class HelloImpl {
/**
* @param name
* @return Say hello to the person.
*/
public String sayHello(String name) {
return "Hello, " + name + "!";
}
}
总的来说，我理解java
浏览 4提问于2010-01-29得票数 2
回答已采纳
首先是问题，然后是解释:我想摆脱Beans XML配置，将一些信息添加到EJB上下文中。
在我的项目(项目的web部分)中，有一个名为StatelessEjbSupportLocal的类，它扩展了LocalStatelessSessionProxyFactoryBean，这是实现：
public class StatelessEjbSupportLocal
extends LocalStatelessSessionProxyFactoryBean {
private UserInfo userInfo;
@Override
public Objec
浏览 1提问于2014-01-02得票数 0
回答已采纳
我正在编写Springboot REST。我的应用程序应该同时使用和生成XML和JSON。我偶然发现了Jackson json Xml依赖项。
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
<version>2.5.4</version>
</dependency>
我在我的pom.xml中添加了这个。现在，我能
浏览 1提问于2015-06-16得票数 3
回答已采纳
有疑问，在下面的示例中会为父类创建一个bean (地址)。如果是的话，我们如何才能证明这一点，对Spring的新认识:)道歉，如果我没有意义。
public class Address {
private String address = "XXX,YYYYY";
public Address(){
System.out.println(" Inside Address Constructor ");
}
public String toString(){
return address ;
浏览 1提问于2020-07-19得票数 1
回答已采纳
我正面临着一个单元测试的问题。我目前在Spring3.2 (@Cacheable)中使用ehcache，一切运行正常，但我想在单元测试期间禁用缓存。
所以在src/test/resources/ehcache.xml中，我写道：
<cache name="myCache"
maxElementsInMemory="1"
eternal="false"
timeToIdleSeconds="0"
timeToLiveSeconds="0"
o
浏览 20提问于2014-02-01得票数 0
在我的构建设置中，我已经发布了构建和连续构建(它轮询scm)。我在pom.xml中使用maven发布插件，并使用目标版本:准备发布:在发行版构建中执行。这个目标检查来自SVN的代码，执行部署并增加pom.xml中的pom.xml编号，并将其重新提交给SVN。因此，由于pom.xml被提交给SVN，并且连续构建是轮询配置管理，因此它被触发并运行连续构建。当发布目标更新并提交pom.xml时，如何使它不触发持续构建？
浏览 2提问于2011-12-06得票数 5
尝试从Primefaces迁移到JSF Push(Websocket)，而在Java项目中尝试JSF，JSF工作得很好。
但是，在Spring应用程序中尝试时，我得到了以下异常
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'pushBean': Unsatisfied dependency expressed through field 'clock'; nested exception is org.springf
浏览 0提问于2019-02-20得票数 2
1回答
我有一个带有标准.ear目录的lib文件。
我在那个.jar目录中有一个lib文件。它包含UserInfoManager，这是一个接口。它不包含(出于这些目的)其他类。它还包含一个META-INF/beans.xml文件。
我在那个.jar目录中有另一个lib文件。它包含一个名为UserInfoResource的类，它是JAX资源类。该类包含以下内容：
@Inject
private UserInfoManager userManager;
接下来，我在.jar文件的根处有一个EJB文件。它包含一个名为UserManagerBean的类，它实现了UserInfoManager接口。这个类使用@
浏览 5提问于2012-06-10得票数 3
回答已采纳
2回答
我有一个扩展ElementTree.Element的类
import xml.etree.ElementTree as ET
from typing import cast
class MyElement(ET.Element):
def my_method(self):
print('OK')
xml = '''<test> <sub/> <sub/> </test>'''
root: MyElement = cast(
MyElement
浏览 3提问于2022-09-23得票数 4
回答已采纳
当使用JAXP管道(使用Saxon )时，用它创建的注释不会出现在结果的.xml中。
首先，我将系统属性设置为获取信息并使用Saxon并定义输入/输出：
System.setProperty("jaxp.debug", "1");
System.setProperty("javax.xml.transform.TransformerFactory", "net.sf.saxon.TransformerFactoryImpl");
StreamSource xsl = ...
StreamResult output = ...
In
浏览 1提问于2014-03-18得票数 0
回答已采纳
当使用字体系列在SVG中呈现文本时，Chrome 32.0.1700.107将选择合适的字体。但是，如果我使用相同的SVG作为img元素的输入，则会使用不正确的字体。如果我指定了我所知道的系统上的特定字体，那么该字体将在svg和img元素中正确地呈现。一个简单的例子：
<svg id="scalingSvg" xmlns="http://www.w3.org/2000/svg" version="1.1" width="100" height="100">
<rect width="
浏览 4提问于2014-02-21得票数 4
我有以下代码：
XmlTextReader DBLPReader = new XmlTextReader("dblp.xml");
// Load the source of the XML file into an XmlDocument
XmlDocument DBLPDoc = new XmlDocument();
// Load the source XML file into the first document
DBLPDoc.Load(DBLPReader);
// Close the reader
DBLPReader.Close();`
其中dblp大约
浏览 8提问于2011-03-22得票数 0
2回答
简单Xml框架松散映射不起作用
、、、、
我试图使用简单的xml框架解析Xml文档的一部分，设置了松散映射标志，但是我得到了一个异常。
XML：
<Body>
<TopGoalScorersResponse>
<TopGoalScorersResult>
<tTopGoalScorer>
<sName>Alan Dzagoev</sName>
<iGoals>3</iGoals>
<sCoun
浏览 2提问于2012-06-22得票数 1
回答已采纳
我有一个叫做“数据库”的项目，它是另一个项目"WEB“的模块，我需要为这个”数据库“项目创建单元测试，但是我很难让payara工作。当我尝试在WildFly 10容器上开始单元测试时，我可以让它工作。但是现在在payara上，我被这个错误困住了：
B�e 02, 2018 3:14:07 ODP. com.sun.enterprise.v3.server.AppServerStartup proceedTo
SEVERE: Shutdown required
MultiException stack 1 of 1
MultiException stack 1 of 2
java.lan
浏览 0提问于2018-03-02得票数 2
1回答
我想刮掉所有的评论，例如，从这个网页：。
我的代码：
library('RSelenium')
library('XML')
library('RCurl')
pJS <- phantom()
shell.exec(paste0("C:\\Users\\Daniil\\Desktop\\R-language,Python\\file.bat"))
Sys.sleep(10)
checkForServer()
startServer()
remDr <- remoteDriver(browserName="ch
浏览 2提问于2016-06-15得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
