[Homework] C# Basics Писане на коментари
Трябва ли на всяка една задача да се пише в кода като коментар условието й?
Трябва ли на всяка една задача да се пише в кода като коментар условието й?
Не е задължително. Лично според моите разбирания, даже трябва да НЕ се пише условието на задачата.
Не.
Хората които го правят,го правят с цел да имат бърз достъп до условието на задачата.
Добра практика е да се пишат коментари само там и само тогава където кода не е достатъчно ясен.
Иначе като за начало е нормално да се пишат малко повече коментари отколкото принципно трябва да се пишат, но поне човек свиква да пише коментари. А това за условията и аз несмятам, че трябва да се пишат като коментар в кода, но определено улеснява проверяващия така, че не го считам за грешка когато проверявам домашни.
Ако кодът някъде е недостатъчно ясен и първото нещо, което ти идва на ум е да напишеш коментар, значи ти идва грешното нещо на ум. Би трябвало, щом сам оценяш нещата за неясни, да намериш начин да ги направиш по-ясни с код, а не с коментар. :)
Нещо не си ме разбрал правилно или аз не съм се изразил достатъчно ясно. :)
Според мен кода колкото и добре да е написан, понякога един коментар от няколко думи прави кода доста по лесен за четене.
Коментарите са най-полезни при по-трудните задачи с дълъг и "увъртян" код. Иначе според мен за условието не е задължително, все пак на някои задачи коментара с условието ще е по-дълъг от решението, което е странно.
Предвид, че курса се казва C# Basics, не е зле да се слагат кратки коментари на по-трудните задачи, например тези със звезда. Кога и в какво количество - трудно е да се каже, по лична преценка.
Ако си прекалил, все някой проверяващ ще ти каже: "абе тука е ОК задачата, ама много коментари си набутал". Случвало ми се е за една задача, съгласих се с критиката и от тогава започнах по-пестеливо с коментарите. От друга страна, 2-3 пъти хората са ми благодарили, че съм слагал коментари на трудните задачи, да речем изпитните, и ми дадоха обратна връзка, че доста им е помогнало това да разберат подхода ми (не че съм писал лош код, просто алгоритъмът сам по себе си не може да бъде изцяло разбран от човек, който тепърва учи условни конструкции примерно и не знае какво е масив).
Под неясен код аз разбирам именно тези случаи, когато авторът на решението очаква, че голяма част от състудентите му едва ли са наясно как се решава конкретната задача. Тогава, вместо хората да се пулят на някакви заклинания, по няколко коментара, обясняващи тая или оная част от кода какво прави, ще направят решението доста по-разбираемо за останалите. Това се явява един вид мини-туториал и проверяващите могат да понаучат нещо без да гугълват ред по ред да видят какви магии се случват и това е полезно за тях.
Доста добре го каза - "кода какво прави", а не "как го прави". Точно така трябва да се описва, примерно: "Populating Database", "Mapping Routes" и т.н, а не описание на всяка стъпка - "Getting elements to populate" ; "Parsing elements", "Converting data model", "Inserting into database".
На конкретен въпрос.....отговори за съвсем друго?!
Колегата пита: "Трябва ли на всяка една задача да се пише в кода като коментар УСЛОВИЕТО й?" т.е на задачата, а не коментари към самия код.
С коментарите Ви за коментари/пояснения към даден код наистина са удобни, стига да не са "роман".
Относно записване на УСЛОВИЕТО на задачата, като коментар над кода ...ми не виждам какъв е проблемът.
1. Не е нужно да гледаш какво се иска всеки път (специално за тези домашни, които не са си и именували правилно файловете)
2. На някой с опит, може и да не му харесва, но за начинаещи е улеснение. (Да не забравят, моля, че и те са се учили в началото та по-спокойно малко!)
Уважашайте труда на другите и давайте конструктивен коментар, а не злобен!