Dash přináší kódování dokumentace na plochu Mac

Pokud jste programátor, již se na dokumentaci velmi spoléháte. Dash (zdarma, 19,99 $ v plné verzi) je aplikace pro Mac, která má zajistit, aby vaše požadované čtení bylo příjemnějším zážitkem.

Většina programátorů nezná preferovaný jazyk volby naruby. Ještě méně se může pochlubit podrobnými znalostmi každé knihovny a API, se kterými přicházejí do styku. Jako programátoři jsme Google. Žádáme Stack Overflow. Čteme dokumentaci. Spousta a spousta dokumentace. Většina lidí čte dokumentaci v prohlížeči, ale existuje lepší způsob. Seznamte se s Dashem.

Pomlčka a dokumentace

Dash je aplikace, která lokálně ukládá dokumentaci z Internetu a umožňuje vám k ní přístup prostřednictvím konkrétní webové aplikace. Lze jej stáhnout z webu vývojáře. Rozdíl mezi bezplatnou a placenou je minimální, bezplatná verze přichází s čekací dobou při spuštění a kdykoli přepínáte mezi sadami dokumentace (docsets) a bude vás chtít koupit.

Pokud se rozhodnete upgradovat na placenou verzi Dash, můžete ji použít alespoň na tolika počítačích Mac, kolik vlastníte (podle vývojářů neomezený počet).

Dashova hodnotová nabídka je založena na počtu knihoven a jazyků, které podporuje, a právě zde svítí.

Téměř každý jazyk, API a knihovna, na kterou si vzpomenete, je zastoupen, stejně jako některé, které jste pravděpodobně ještě neslyšeli. Zde jsou dobře zastoupeny jak web, mobil, tak systém.

Osobně se pro web vyvíjím v přední i zadní kapacitě a vše, co používám, je zde přítomno. Kvalita dokumentace je bohužel trochu smíšená taška.

Kvalita dokumentace

Vývojáři sami nevytvořili dokumentaci, takže to není jejich chyba. Jak jsem již řekl, Dash ukládá pouze existující dokumentaci.

Problém je v tom, že některé jazyky prostě nejsou dobře zdokumentovány - jako zjednodušené JavaScripty s protijedem CoffeeScript CoffeeScript je JavaScript bez bolesti hlavy CoffeeScript je JavaScript bez bolesti hlavy Nikdy jsem moc rád psal JavaScript tolik. Od chvíle, kdy jsem použil svůj první řádek, jsem vždycky nesnášel, že to, co v něm píšu, vždy vypadá jako Jackson…. Jejich dokumentace je více “Není to super??” průvodce jak ukázat příklady jazyka v akci, aniž by to vlastně vysvětlil jak věci fungují.

Navíc v případě CoffeeScript to nevypadá dobře v Dash. Je to mnohem vhodnější pro webový prohlížeč.

S tím bylo řečeno, některé sady dokumentace fungují velmi dobře, jako ty pro Ruby. Toto je jazyk, který pohání rámec webové aplikace Ruby On Rails 3 Interaktivní, zábavné a bezplatné způsoby, jak začít s učením Programovací jazyk Ruby 3 Interaktivní, zábavné a bezplatné způsoby, jak začít s učením Ruby, programovací jazyk Ruby je expresivní, velmi vysoká úroveň , skriptovací jazyk. Používá se na webu hlavně jako součást rámce pro vývoj webových aplikací Ruby on Rails, ale také jako samostatný. Pokud vás zajímá, co Ruby (ne…, má plně prohledávatelnou dokumentaci a pěkně zapadá do estetiky Dash.

Tam jsou také podvádět listy k dispozici ke stažení v Dash. Ty se nezaměřují na jazykové funkce, ale spíše na pokročilé funkce Gitu, oblíbeného textového editoru zaměstnanců. Sublime Text 2 Vyzkoušejte Sublime Text 2 pro vaše potřeby pro úpravy kódu napříč platformami Vyzkoušejte Sublime Text 2 pro vaše úpravy kódu napříč platformami Vyžaduje Sublime Text 2 je editor napříč platformami, o kterém jsem slyšel teprve nedávno, a musím říci, že jsem opravdu ohromen i přes značku beta. Můžete si stáhnout plnou aplikaci bez zaplacení penny… a 3 a dalších populárních softwarových balíčků.

Kódy jsou také k dispozici pro funkce HTTP, HTML a CSS pojmenované barvy.

Přístupnost

Znám spoustu vývojářů, kteří se snaží číst černý text na bílém pozadí. Někteří dokonce nosí speciálně zabarvené brýle, aby jim usnadnili čtení. Někteří prostě potřebují zvětšit text.

Ve službě Dash jsem nenašel žádná konkrétní nastavení usnadnění přístupu ani nenašel žádný způsob, jak zvětšit velikost textu. Pro některé zrakově postižené uživatele by to mohlo být řešení. OS X však obsahuje některé funkce usnadnění přístupu (Předvolby systému> Systém> Usnadnění), díky čemuž by mohl být Dash trochu použitelnější.

Závěr

Měli byste získat placenou verzi Dash? To záleží. Ve skutečnosti neexistují žádné přesvědčivé funkce, díky nimž by aktualizace stála za náklady, ale budete projekt podporovat tím, že se do něj vložíte.

Bezplatnou verzi Dash používám téměř denně. Pokud zavěsíte kód pro bydlení a vlastníte Mac, potřebujete tuto aplikaci. Není to dokonalé, ale práce je dokončena.

Stažení: Dash pro Mac OS X (zdarma, 19,99 $ pro plnou verzi)

Co myslíš? Stáhněte si jej a dejte nám vědět své myšlenky v komentářích níže.

Fotografický kredit: kód (Michael Himbeault)