我们正在开发一种类似 RPG 的游戏描述语言。以前，我们使用丑陋的低级 XML - 但现在我们已经切换到更高级别的、几乎人类可读的 JSON(直到我们推出新的图形编辑器并且不再需要手动编写文件；尽管我们会可能保留它用于低水平、快速和肮脏的创作)。游戏引擎是用 Java 编写的。
您将如何记录将由 Java 使用的 JSON 文件格式？。我们有超过 50 种“对象类型”，从场景到背景、对话、过渡、项目、角色等。我们希望在添加和调整功能时保持格式更新，因此易于更新非常重要。目前，JSON 的一些位被转换为 Java 的许多位——因此一个好的文档目标可能是执行此转换的 Java“JSON Reader”模块。另一种方法可能是记录 JSON 格式的某种“规范”，例如可以用某种“JS API”编写。
我们可以使用的一些东西:
- jsDoc - 我们可以在 JS 中记录每个对象类型，作为假 JS API 的参数。
- Java JSON-Reader 源代码中的旧 JavaDoc；但JavaDoc不懂JS，AFAIK；所以我们可能需要写一个 custom JavaDoc我们的 JS 标签。
- (此处是您的建议)
注意:这不是一个“什么是最好的工具”问题；我的目标只是为 Java 中的 JSON 找到一个或多个候选文档工作流程。
最佳答案
您有两个选择:
您可以选择以 Java 为中心，并定义可记录的 Java 类，然后序列化为 JSON:Java 优先。
您可以选择借助架构(类似于与... XML 编码一起使用的 XML 架构)来定义 JSON 包含的内容:JSON 优先。它可以由 http://www.json-schema.org 定义。 .
关于java - 如何维护基于 JSON 的领域特定语言的文档？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/20047349/