search

FilipMatys / MPR2015

Repository for MPR Project for year 2015 at VUT FIT Brno.
0 stars 0 forks source link

Dokumentace zdrojového kódu #41

Open KratochvilJiri opened 9 years ago

KratochvilJiri commented 9 years ago

Jsi zodpovědný a řídíš výtvoření dokumentace zdrojových kódu aplikace, takže bych tě poprosil, aby jsi určil nebo alespoň navrhl, jakým způsobem bude dokumentace prováděna. Myslím, že nejlepší a už jsme se o tom asi i bavili, by bylo generovat dokumentaci přímo z Visual Studia, či pomocí jiného nástroje.

Pokud souhlasíš, měl by jsi zajistit, aby všichni členové průběžně komentovali svůj kód a dodržovali správný syntax komentářů pro následné generování. Ušetří se tím hodně práce.

KratochvilJiri commented 9 years ago

Jak jsi se rozhodl? Informoval jsi členy týmu?

FilipMatys commented 9 years ago

Domluvilo se, že dokumentace zdrojového kódu bude psána v anglickém jazyce. Dokumentace aplikace bude generována pomocí nástroje Microsoft Visual Studio.

KratochvilJiri commented 9 years ago

Ví všichni jak vytvářet komentáře, aby nebyl problém následně generovat dokumentaci?

KratochvilJiri commented 9 years ago

přesunuto do složky - "ke schválení". Nakonci implementace poprosím o aktualizaci.

FilipMatys commented 9 years ago

Generování dokumentace sice funguje, ale všiml jsem si, že nedochází příliš ke komentování zdrojového kódu. Zkuste na to, prosím, myslet. Je to další z komunikačních průserů, stejně jako to, že tento komentář bude opět většina z vás opět ignorovat.

azuritus commented 9 years ago

Nahrál jsem tam aktualizovanou verzi.