html标记语言图像标记

去年大约这个时候，我为本专栏文章 。 语言选择的话题最近出现了好几次，所以我认为现在该是时候以我的偏见来重新讨论这个话题了。 我在这里解释为什么我更喜欢我的语言，而不是为您开任何处方。 毕竟，我不是医生。

一位同事问我对以获得技术文档的帖子的看法。 我公司的文档是用Sphinx渲染的reStucturedText编写的，但是我不时地抱怨着转向DocBook XML之类的东西。 对我来说，reStructuredText可以放入Anti-Goldilocks区域，该区域并不像Markdown那样简单，但不如DocBook XML丰富。 它的亮点是使用Sphinx为Python 。

最近， 的主要维护者宣布他打算 。 从未使用过AsciiDoc，我为自己的主张如此惊讶而感到惊讶，但是当我跟进后续对话时，我意识到它非常适合类似书本的文档。

他们说：“将内容与演示文稿分开。” 诸如DocBook和AsciiDoc之类的语言使作者可以说：“这是一个GUI按钮”。 它可能最终以粗体显示，但您不只是添加<em>并称之为一天。 内容与演示文稿分开； 例如，诸如类的渲染工具使用级联样式表（CSS）来控制演示。

在书籍式文档中，我最喜欢做的事情是包含标注。 警告，提示等是您的读者的重要功能。 在大多数情况下，读者最终会浏览本书的某些部分，或者是因为他们正在寻找特定的部分，或者是因为您的散文太无聊并且失去了兴趣。 调出特别重要的部分有助于确保读者获得您真正想要的信息。 另外，它们为文本墙添加了漂亮的分隔符。 公平地讲，reSTructuredText对它们提供了一些支持，但是我从来没有能够使它们像我想要的那样漂亮或明显。

现在我还没有赞美什么？ 降价。 减价优惠。 不要误会我的意思，我爱Markdown。 这篇文章已提交给Markdown的编辑。 我在Markdown的学校里做笔记。 立即编写和以源代码形式阅读非常容易。 对于简短的独立文档，Markdown是最好的。

但是Markdown的易写性与Markdown的最终（缺乏）功能是矛盾的。 除非您嵌入了许多HTML（然后您可能不使用Markdown），否则您将不会获得大量的语义丰富性，而这些丰富性在长格式材料中变得更加重要。 选择Markdown的目的很诱人，因为它使贡献的障碍如此之低，但是当选择使开发人员或用户（在这种情况下为作家和读者）的生活更轻松时，成功的项目往往会偏向用户。

所以你有它。 文档语言并非千篇一律，因此选择适合所写文档的语言至关重要。

在评论中告诉我为什么喜欢您选择的语言。

翻译自:

html标记语言图像标记