Jquery ui 教程的优雅代码注释？

我一直在写一些教程，我试图找到一种优雅的方法，在教程中为代码添加逐行注释

例如，假设我有如下代码：

<h1>Demo of web page</h1>
<p>This is a paragraph</p>

网页演示
这是一段

我希望能够添加一些东西（可能是工具提示或某种灯箱效果），允许我向读者展示每一行的解释，同时仍然让他们在上下文中看到这一行。我能想到的最好的解释是散文式的解释，比如“以

开头的一行是标题。”

---

有人见过这样的东西吗？

使用标题属性怎么样

<h1 title="your hover text">your text</h1>

您的文本

如何使用标题属性

<h1 title="your hover text">your text</h1>

您的文本

您可能想查看docco：

---

它是用CoffeeScript编写的，并从一个源文件中生成一个HTML文档，将注释部分和代码分解。它将注释设置为一列中每个部分的注释，并在另一列中正确突出显示相应的代码。我认为这是一种很好的简单方法，可以在保持代码上下文的同时浏览注释。哦，它还知道降价。

你可能想看看docco：

---

它是用CoffeeScript编写的，并从一个源文件中生成一个HTML文档，将注释部分和代码分解。它将注释设置为一列中每个部分的注释，并在另一列中正确突出显示相应的代码。我认为这是一种很好的简单方法，可以在保持代码上下文的同时浏览注释。哦，它也知道降价。

我想我可能已经找到了可以与Docco抗衡的东西：Twitter引导的popover功能：

---

我不确定它是否真的看起来不错，但这似乎是一个好的开始。

我想我可能已经找到了可以与Docco抗衡的东西：Twitter引导的popover功能：

---

我不确定它是否真的看起来不错，但这似乎是一个好的开始。

古老但很好的问题，当我发现这个时，我正在寻找类似的东西。做HTML注释的方法有很多种

如果您希望注释能够简单地告诉用户每一行的功能，我会为小部分代码编写HTML注释，为大量代码编写更大的外部注释。然后，如果您愿意，您可以使用自定义JS解析它们以显示更漂亮的框

<h1>Heading</h1> <!-- A heading element -->
<p>paragraph</p> <!-- A paragraph element -->
<p>Paragraph with
    <b>Bold</b>      <!-- An inline Bold element -->
text</p>

标题
段落

带段落
大胆的
正文

---

对于更大数量的代码，我会考虑使用一些类似于创建的文档。当然，它是针对JavaScript的，但谁说类似的功能不能用于HTML呢。由于这是用jQueryUI标记的，您可能还对一个。

古老但很好的问题感兴趣，当我发现这个问题时，我正在搜索类似的东西。做HTML注释的方法有很多种

如果您希望注释能够简单地告诉用户每一行的功能，我会为小部分代码编写HTML注释，为大量代码编写更大的外部注释。然后，如果您愿意，您可以使用自定义JS解析它们以显示更漂亮的框

<h1>Heading</h1> <!-- A heading element -->
<p>paragraph</p> <!-- A paragraph element -->
<p>Paragraph with
    <b>Bold</b>      <!-- An inline Bold element -->
text</p>

标题
段落

带段落
大胆的
正文

---

对于更大数量的代码，我会考虑使用一些类似于创建的文档。当然，它是针对JavaScript的，但谁说类似的功能不能用于HTML呢。因为这是用jquery UI标记的，所以您可能还对一个.

感兴趣，这几乎正是我想要的。如果我这样做，我可能会使用Python端口Pycco。我不确定这是否值得为我的网站增加额外的复杂性，但这是我见过的最好的一次。功能完全正确。谢谢，艾略特。（刚刚看到你的Python端口评论。是的！）这几乎正是我想要的。如果我这样做，我可能会使用Python端口Pycco。我不确定这是否值得为我的网站增加额外的复杂性，但这是我见过的最好的一次。功能完全正确。谢谢你，Eliot。（刚刚看到你的Python端口评论。是的！）它适用于html，但不适用于其他语言。而且，它使代码本身更加混乱。但是，谢谢你的建议。这对html有效，但对其他语言无效。而且，它使代码本身更加混乱。但是，谢谢你的建议。这并不是一个很好的回答你的光盒要求，但我确实认为它可以自己动手做，不，我还没有看到一个预制的-如果我有时间，我会拼凑一些东西。这并不是一个很好的回答你的光盒要求，但我确实认为它可以自己动手做，不，我还没有看到一个预制的——如果我有时间，我会拼凑一些东西。