103

对于 XML 文档，是否有任何事实上的标准或其他标准？例如，哪个是编写标签的“最佳”方式？

<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />

同样，如果我有一个更好的属性的枚举值

<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
4

13 回答 13

50

我怀疑最常见的值是camelCased - 即

<myTag someAttribute="someValue"/>

特别是，如果与代码生成器混合使用空格（即将 xml 序列化为对象），空格会导致一些故障，因为没有多少语言允许使用空格的枚举（需要在两者之间进行映射）。

于 2009-01-14T10:25:26.563 回答
36

XML Naming Rules

XML elements must follow these naming rules:

    - Element names are case-sensitive 
    - Element names must start with a letter or underscore
    - Element names cannot start with the letters xml(or XML, or Xml, etc) 
    - Element names can contain letters, digits, hyphens, underscores, and periods 
    - Element names cannot contain spaces

Any name can be used, no words are reserved (except xml).

Best Naming Practices

    - Create descriptive names, like this: <person>, <firstname>, <lastname>.
    - Create short and simple names, like this: <book_title> not like this: <the_title_of_the_book>.
    - Avoid "-". If you name something "first-name", some software may think you want to subtract "name" from "first".
    - Avoid ".". If you name something "first.name", some software may think that "name" is a property of the object "first".
    - Avoid ":". Colons are reserved for namespaces (more later).
    - Non-English letters like éòá are perfectly legal in XML, but watch out for problems if your software doesn't support them.

Naming Styles

There are no naming styles defined for XML elements. But here are some commonly used:

    - Lower case    <firstname> All letters lower case
    - Upper case    <FIRSTNAME> All letters upper case
    - Underscore    <first_name>    Underscore separates words
    - Pascal case   <FirstName> Uppercase first letter in each word
    - Camel case    <firstName> Uppercase first letter in each word except the first

reference http://www.w3schools.com/xml/xml_elements.asp

于 2015-06-30T06:13:56.427 回答
15

我喜欢 TitleCase 用于元素名称，而 camelCase 用于属性。两者都没有空格。

<AnElement anAttribute="Some Value"/>

顺便说一句，我快速搜索了 XML 中的最佳实践，并找到了这个相当有趣的链接：XML 模式：最佳实践。

于 2009-01-14T11:33:25.600 回答
14

对我来说，这就像讨论编程语言的代码风格：有些人会争论一种风格，有些人会捍卫另一种风格。我看到的唯一共识是：“选择一种风格并保持一致”！

我只是注意到许多 XML 方言只使用小写名称（SVG、Ant、XHTML...）。

我没有得到“属性值中没有空格”规则。不知何故，它引发了“在属性中放入什么以及作为文本放入什么？”的辩论。
也许这些不是最好的例子，但有一些众所周知的 XML 格式在属性中使用空格：

  • XHTML，尤其是类属性（您可以放置​​两个或更多类），当然还有 alt 和 title 属性。
  • SVG，例如路径标签的 d 属性。
  • 两者都具有样式属性...

我不完全理解反对这种做法的论据（似乎只适用于某些用法），但它至少是合法的，并且被广泛使用。显然有缺点。

哦，自动关闭斜线之前不需要空格。:-)

于 2009-01-14T12:10:53.277 回答
8

我倾向于使用小写或驼峰标记，因为属性通常应该反映数据值 - 而不是内容 - 我会坚持一个可以用作任何平台/语言可能感兴趣的变量名的值，即避免空格，但其他两种形式都可以

于 2009-01-14T10:26:19.383 回答
8

这是主观的，但如果元素标签中有两个单词，则可以通过在单词之间添加下划线（例如<my_tag>）而不是不使用分隔符来增强可读性。参考：http ://www.w3schools.com/xml/xml_elements.asp 。所以根据 w3schools 的答案是：

<my_tag attribute="some value">

该值不需要使用下划线或分隔符，因为您可以在属性值中使用空格，但不能在元素标记名称中使用空格。

于 2011-09-08T07:59:52.000 回答
7

许多以文档为中心的 XML 方言使用小写基本拉丁文和破折号。我倾向于这样做。

将 XML 直接映射到编程语言标识符的代码生成器很脆弱，并且（除了简单的对象序列化，例如 XAML）应避免在可移植文档格式中使用；为了获得最佳重用和信息寿命，XML 应该尝试匹配域，而不是实现。

于 2009-01-14T14:53:34.167 回答
3

rss 可能是世界上使用最多的 xml 模式之一，它是驼峰式的。

规范在这里：http ://cyber.law.harvard.edu/rss/rss.html

假设它在模式中没有节点属性，但所有节点元素名称都是驼峰式命名的。例如：

lastBuildDate 管理编辑器 pubDate

于 2011-10-06T18:03:10.843 回答
2

我通常将 XML 命名约定与代码其他部分中的相同命名约定保持一致。原因是当我将 XML 加载到 Object 中时，它的属性和元素名称可以引用为项目中当前使用的相同命名约定。

例如，如果您的 javascript 使用 camelCase，那么您的 XML 也使用 camelCase。

于 2012-01-08T04:40:21.843 回答
2

Microsoft 采用两种约定：

  1. 对于配置，Microsoft 使用camelCase。查看 Visual Studio 配置文件。对于VS2013，它存储在：

    C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\devenv.exe.config

例子：

<startup useLegacyV2RuntimeActivationPolicy="true">
  <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
</startup>
  1. Microsoft 还为他们的 XAML 使用大写。我想这是为了区别于 HTML（使用小写）。

例子：

<MenuItem Header="Open..." Command="ApplicationCommands.Open">
    <MenuItem.Icon>
        <Image Source="/Images/folder-horizontal-open.png" />
    </MenuItem.Icon>
</MenuItem>
于 2015-03-17T23:42:43.167 回答
1

没有明确的建议。根据 W3C 的其他建议，即XHTML的建议，我选择了小写：

4.2. 元素和属性名称必须小写

XHTML 文档必须为所有 HTML 元素和属性名称使用小写字母。这种差异是必要的，因为 XML 区分大小写，例如 <li> 和 <LI> 是不同的标记。

于 2016-05-27T00:23:07.267 回答
0

XML 命名规则

XML 元素必须遵循以下命名规则：

  • 名称可以包含字母、数字和其他字符
  • 名称不能以数字或标点符号开头
  • 名称不能以字母 xml（或 XML，或 Xml 等）开头
  • 名称不能包含空格 可以使用任何名称，不保留任何字词。

资料来源：W3学校

于 2012-09-06T09:05:18.050 回答
0

我一直在寻找一个好的方法，也阅读了这个帖子和其他一些帖子，我会投票赞成使用连字符。

它们在 ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA )中被广泛使用，可以在许多源代码中看到，因此很常见。正如这里已经指出的那样，它们当然是允许的，这里也解释了这一点：在 XML 元素名称中使用 -

还有一个附带的好处：当结合 CSS 编写 HTML 时，你经常有一些类的名字默认使用连字符作为分隔符。现在，如果您有使用 CSS 类的自定义标签或使用 CSS 类的标签的自定义属性，那么类似：

<custom-tag class="some-css-class">

更加一致并且阅读 - 在我的拙见中 - 比：

<customTag class="some-css-class">

于 2016-03-25T14:49:54.993 回答