04.Документиране и коментиране на кода

Документиране и коментиране на кода
Не винаги писането на качествен, самодокументиращ се код е най- добрата практика. При писането на софтуер за микроконтролери, например, качествения код не е на 100% препоръчителен.

Външната докумнетация на даден код се намира във отделни файлове, които съпътстват нашия код
Вътрешната документация се намира в сорс кода

Грешно е да коментираме всеки ред от кода

Доброто коментиране е да кажем защо правим дадена операция, а не какво прави тази операция

Ако попаднем на лош код не трябва да го документираме, а да го препишем така че да бъде самообяснителен

Това дали ще документираме кода зависи от няколко фактора като например дали кода ще е само за конкретния екип, в който работим или пък ще споделим кода в Интернет

Documentation guidelines:
-	Describe the design approach to the class
-	Comment the class interface
-	Don’t document implementation details in the class
-	Describe the purpose and contents of each file

C# XML documentation
-	с 2 наклонени черти правим коментар, с 3 наклонени черти документираме
има много тагове като <code> и други, които могат да се използват в XML документацията