Dokumentace a self-documenting kód

Abstrakt

„Dokumentace je zbytečná, protože můj kód je zřejmý.“ „Na minulém projektu jsme nepsali dokumentaci. Používali jsme self-documenting code.“ I na takové a podobně vyhraněné názory můžete narazit, když k vám přijde nový kolega a diskutujete s ním jeho první pull request. Myšlenka psaní naprosto zřejmého samopopisného kódu je samozřejmě krásná. Je ale možné, že dokumentaci vůbec nepotřebujeme? Proč bychom ji měli psát a jak tedy k ní přistoupit? V rámci této přednášky se podíváme na několik důvodů, proč bychom dokumentaci měli psát a na konkrétních ukázkách probereme pár tipů ke zlepšení dokumentace a čitelnosti kódu.

Gravatar

Radoslav Zápotocký

Rado se zabývá fullstack vývojem a architekturou, zejména v oblasti ASP.NET a SQL Server, v poslední době také Angularu. Během svého mnohaletého působení se setkal širokou škálou projektů v různých technologiích, včetně Javy, Oracle či SAP/Sybase. Aktuálně působí jako SW architekt na vývoji systému pro bankovního klienta, kde zastřešuje aplikační architekturu, vývojový proces a také se podílí na vývoji samotném.