2012-03-13 61 views
2

如何为xhtml jsf页面编写好的文档?xhtml页面的文档?

我可能会使用<!-- comment -->,但这会使代码非常混乱,并且使其有时比没有注释更难读。

有没有办法更好地做HTML评论或内联文档?

+1

在所有的语言中,我认为(X)HTML最适合[self-documenting code](http://en.wikipedia.org/wiki/Self-documenting)。你有什么用例取决于重要的标记文档? – Quentin 2012-03-16 17:04:18

回答

1

这可能不是您正在寻找的答案,但可能是大量html评论的替代方案。

我发现文档支持bean方法比xhtml本身更容易(和合乎逻辑)。我使用html评论的唯一方法是识别页面上的大部分/区域,以便更容易找到。

具有可读性和命名变量/逻辑比任何评论好得多。