HTML 5 - dokumentowanie przeznaczenia tagu

Question

Zastanawiam się, czy tworząc aplikacje semantycznie opartą o html5 powinienem jakoś dokumentować przeznaczenie danego tagu. Załóżmy, że renderuje listę słów  wewnątrz tagu article. Czy nie powinienem nadać mu  jakiejś opisowej klasy typu word-list lub dodać komentarz np:

<!-- word list -->
<article>
... 
</article>

Wydaje mi się, że "goły" article nie mówi wystarczająco o tym co właściwe w sobie zawiera. 

Answer 1

Komentarze są tylko i wyłącznie dla Ciebie. Jeśli ich potrzebujesz, opisz ten fragment kodu.

Comments

Komentarze są tylko i wyłącznie dla Ciebie

jeśli nad projektem pracuje jedna osoba to tak, ale co jeśli nad jakimś projektem pracuje kilkadziesiąt programistów :)? Zbyt mocno uogólniasz :)

---

A lepiej do takiego opisu użyć komentarzy, czy pustych klas css ?

---

szczerze to jeszcze nie zdarzyło mi się, abym musiał cokolwiek komentować w kodzie html... co prawda po częsci wynika to z tego, że pracuję głównie w apkach na frameworku Angular, ewentualnie React, gdzie w sumie użycie odpowiednio nazwanych komponentów automatycznie załatwia ten problem... Jeśli uważasz, że komentarz jest niezbędny to w sumie spoko, ja nie pisałem, że komentarze są złe tylko że nie są one jedynie dla autora ale powinny być na tyle jasne, aby każdy zrozumiał o co chodzi.

a co do klas... w sumie to zakładam, że raczej pewnie i tak będziesz to jakoś stylował, więc może właśnie nazwa klasy mogłaby być takim komentarzem :)

---

Front end aplikacji piszę w Vue. Mając dobrze nazwane kompletny faktycznie łatwo się połapać w strukturze aplikacji, o wiele gorzej to jednak wygląda gdy zerknę na wyrenderowany DOM. Gąszcz zagnieżdżonych tagów. Zastanawiam się czy jest potrzeba jakoś to ponazywać, żeby dało się w tym połapać, czy jednak finalny html nie jest przeznaczony do interpretacji przez człowieka