xhtmlページのドキュメント？

Question

xhtml jsfページのドキュメントを作成するにはどうすればよいですか？

私は<!-- comment -->を使用するかもしれませんが、それはコードを非常に混乱させ、時にはコメントなしで読むよりも読むことができなくなります。

HTMLコメントやインラインドキュメントを改善する方法はありますか？

Answer 1

これはあなたが探している答えではないかもしれませんが、大量のHTMLコメントに代わるものかもしれません。

私は、xhtml自体よりもバッキングBeanのメソッドを文書化する方がはるかに簡単で（論理的な）ことが分かりました。私がhtmlコメントを使用する唯一の方法は、ページ上の大きな部分/区域を識別して見つけることです。

読み込みが可能で、名前が変わった変数/ロジックを持つことは、どのようなコメントよりも優れています。