2012-03-13 2 views
2

xhtml jsf 페이지에 대한 좋은 설명서를 작성하려면 어떻게해야합니까?xhtml 페이지 관련 설명서?

나는 <!-- comment -->을 사용할 수도 있지만 코드가 너무 복잡해져서 주석없이 읽을 때가끔 읽을 수없는 경우가 있습니다.

HTML 주석이나 인라인 문서를 더 잘 만들 수있는 방법이 있습니까?

+1

외부의 모든 언어에서 (X) HTML은 [자체 문서화 코드] (http://en.wikipedia.org/wiki/ Self-documenting)에 가장 적합하다고 생각합니다. 마크 업에 대한 중요한 문서에 따라 어떤 유스 케이스가 있습니까? – Quentin

답변

1

이것은 사용자가 찾고있는 답변이 아니지만 방대한 HTML 주석 처리의 대안 일 수 있습니다.

backing bean 메소드를 문서화하는 것이 xhtml 자체보다 훨씬 쉽고 (논리적 인) 것이 사실입니다. 내가 HTML 주석을 사용하는 유일한 방법은 찾기 쉽도록 페이지에서 큰 부분/영역을 식별하는 것입니다.

읽기 쉽고 잘 명명 된 변수/논리를 갖는 것이 어떤 주석보다 훨씬 낫습니다.