Софтуерно Инженерство
Loading...
kristopher avatar kristopher 4 Точки

Кога се пише // , какви са условията и ограниченията при използването му

Видях от задачите, че се ползва за някакво пояснение за да се даде информация за някоя стойност например. Пише се в самия код и не се вижда на изхода. Може ли детайлна информация, защото не чух на лекциите за него. може и да съм пропуснал. А и в интернет не намерих информация. Благодаря.

1
Programming Basics
rosenrusev avatar rosenrusev 175 Точки

Здравей,

 

Ето каква информация може да се прочете в msdn за коментарите: http://msdn.microsoft.com/en-us/library/tkxs89c5(v=vs.71).aspx .

Изпозлването на коментарите // и /**/ е взаимствано от езиците C/C++. Информацията между скобите в коментарите се игнорира от компилатора. 

Може да следваш следните критерии преди да започнеш да пишеш коментари:

1) Не прекалявай с употребата им.

2) Кодът ти трябва да е достатъчно ясно написан, за да е четим и без кометари.

3) Коментарът не трябва да повтаря написаното в кода.

4) Ако все пак се налага да сложиш коментар, то помисли, опитай се и преработи кода си така, че да няма нужда от коментари.

5) Коментарът не трябва да повтаря кода.

6) Коментарът трябва да представя на по-високо ниво, описано това, което реализираме в дадения метод или клас. 

С няколко думи казано кода ти трябва да е четим, ясен и да говори сам за себе си и без да се налага употребата на коментари.

Добра практика е в коментарите да се поставя т.н. псевдокод, за пояснение на описанието.

И като за накрая може да се спомене нещо, което г-н Наков ни казва не еднократно, а именно, че лошият код няма как да стане по-добър с коментари. Ето защо, за да стане наистина добър кода, той трябва да се преработи.

п.с. Не е срамно да бъркаш и да си признаваш, като пишеш код, да искаш и търсиш помощ, срамно е, ако не го правиш.

Ето защо ти благодаря за темата, за някои хора тя ще е полезна :)

7