Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implementační detaily v dokumentaci je možné vynechat. #2

Open
xtompok opened this issue Nov 13, 2019 · 0 comments
Open

Implementační detaily v dokumentaci je možné vynechat. #2

xtompok opened this issue Nov 13, 2019 · 0 comments

Comments

@xtompok
Copy link

xtompok commented Nov 13, 2019

Importy není potřeba popisovat, je jasné z kódu.
V dokumentaci není potřeba uvádět, že jsi použila nějaký konkrétní typ cyklu, je to jasné ze zdrojáku. Stačí uvést výsledek té operace, ke které jsi ten cyklus použila.
Popis, co dělá která proměnná, je vhodnější uvést do zdrojáku jako komentář k proměnné, ne do uživatelské dokumentace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant