Puncte:-2

Cum generez automat documentația pentru site-ul meu?

drapel hk

Lucrez la un site Drupal complex cu o mulțime de module personalizate, entități personalizate, clase personalizate, vizualizări personalizate, evenimente personalizate, abonați de evenimente personalizate, formulare personalizate, controlere personalizate. Pe scurt, o mulțime de cod personalizat.

Este o mare provocare să încercăm să păstrăm actualizată documentația tehnică a sistemului atunci când continuăm să facem modificări în aplicație în mod continuu.

Există vreo modalitate de a genera automat documentația tehnică pentru site? De exemplu.

Un modul este folosit pentru x, y, z Vizualizarea V este folosită pentru astfel de lucruri, blocurile de vizualizare sunt folosite în astfel de pagini. Tipul de conținut C este utilizat pentru l, m, n și este utilizat în vizualizările V1, V2, V3.

Dacă nu este complet automat, cel puțin parțial și aveți un mecanism pentru a adăuga manual articolele rămase?

Editați | ×: Mulțumesc pentru sfatul despre modulul API @cilefen. Aceasta pare a fi o modalitate bună de a genera documentație despre codul personalizat. Cu toate acestea, există și piese care fac parte din configurație - cum ar fi vizualizări, machete, blocuri etc. Care nu ar fi documentate cu modulul API.

Puncte:1
drapel id

Utilizare modulul API pentru a genera documentație din cod. Doxygen sau phpDocumentor pot funcționa și pentru dvs., în funcție de nevoile dvs.

Jaypan avatar
drapel de
Am secund modulul API.
drapel hk
Mulțumim pentru sfatul despre modulul API. Aceasta este o variantă interesantă. Cum documentați vizualizările, aspectele, tipurile de conținut și alte elemente care fac parte din configurație?
drapel id
Acesta este și modulul API. Luați în considerare orice fișier *.api.php din Drupal generează pagini pe site-ul API. Intrăm acum pe teritoriul opiniei, dar și https://www.mkdocs.org este simplu și ușor de utilizat pentru documentare ad-hoc.

Postează un răspuns

Majoritatea oamenilor nu înțeleg că a pune multe întrebări deblochează învățarea și îmbunătățește legătura interpersonală. În studiile lui Alison, de exemplu, deși oamenii își puteau aminti cu exactitate câte întrebări au fost puse în conversațiile lor, ei nu au intuit legătura dintre întrebări și apreciere. În patru studii, în care participanții au fost implicați în conversații ei înșiși sau au citit transcrieri ale conversațiilor altora, oamenii au avut tendința să nu realizeze că întrebarea ar influența – sau ar fi influențat – nivelul de prietenie dintre conversatori.