2012-03-13 60 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評論的唯一方法是識別頁面上的大部分/區域,以便更容易找到。

具有可讀性和命名變量/邏輯比任何評論好得多。