| Autor | Zpráva | ||
|---|---|---|---|
| joe Profil |
#1 · Zasláno: 13. 6. 2014, 12:09:15
Rád bych se podělil se svou šablonou pro generování JavaScriptové API dokumentace pomocí JSDoc3, protože všechny, které jsem našel se mi zdály docela ošklivé :-) a tak nezbývalo nic jiného, než věnovat chvíli něčemu, co se (mi) bude příjemně prohlížet.
Přijímám návrhy, nápady a připomínky k dalšímu vylepšení! Ukázka: Vygenerovaná dokumentace Stáhnutí: repozitář na GitHubu (barevně jsem vycházel ze své šablony pro Adminer 4) |
||
|
Časová prodleva: 4 dny
|
|||
| Chamurappi Profil |
#2 · Zasláno: 17. 6. 2014, 17:25:45
Reaguji na joa:
Koukám na ukázku. 1) Ze zaškrtávátek show inherited, public, protected a private funguje jen to první. 2) Jen náhodou jsem zjistil, že klik na řádek s metodou rozbaluje podrobnosti, včetně odkazu na zdroják příslušné metody … 3) … který ovšem při kliku nic nedělá. Zřejmě je zablokovaný skriptem, můžu si ho ovšem otevřít do nového tabu. 4) Koukám tedy na obarvený kód. Když ho chci zkopírovat, v Exploreru se kopíruje i včetně čísel řádků, ve Firefoxu 11 nejde označit a v nové Mozille se kopíruje bez odřádkování. V obou Mozillách se zobrazují prázdné řádky nižší než ostatní, takže číslování nevypadá hezky. 5) V Exploreru 8 nefunguje odkazování na konkrétní řádek, protože používáš document.getElementsByClassName. Proč nejsou ídéčka řádků natvrdo v HTML?
6) @param {int} count Count of steps — připadá mi zvláštní mluvit u JavaScriptu o typu int.
|
||
| joe Profil |
#3 · Zasláno: 17. 6. 2014, 20:45:21 · Upravil/a: joe
Díky za vyzkoušení, co půjde, tak opravím. Používám to převážně pro své dokumentace, nepředpokládám, že bude někdo prohlížet dokumentaci k JavaScriptu v IE :-)
1 - Kde jsi to prosím zkoušel? V té ukázce se zdá, že fungují všechny, kromě prvního, tam je nějaký problém - na to kouknu, zkoušel jsem tady 2 - Ano :-) šipka by byla vhodná, doplním. 3 - Odkazy opravím. 4, 5 - Jen jsem obarvoval, nezkoušel jsem a nevím, co se na výpis skriptu používá, můžu se na to až bude čas kouknout a nebo uvítám pull request :-) 6 - Opravím, zvyk z jiných jazyků (má tam být samozřejmě number)(Chamurappi:) Jinak nebyl by nějaký rozumný nápad, jakým způsobem řešit vyhledávání v dokumentaci? (pár tipů mám, ale rád bych předem viděl i jiné nápady) |
||
| joe Profil |
#4 · Zasláno: 18. 6. 2014, 00:17:46
Tak upraveno, zaškrtávátka jsem přepsal, u řádků je šipka (v chytrých prohlížečích se otočí), odkaz v detailu metody je opravený, obarvený kód jsem trochu upravil pro Firefox, řádky jsou označené i v IE8.
int přepsán na number.
|
||
|
Časová prodleva: 10 let
|
|||
0