У кодирању, коментари су један од ретких начина за очување мисли за будућност. Они вам могу помоћи да пређете кроз исечке кода и могу бити од помоћи за следећег програмера који ће покушати да разуме шта сте написали данима раније. Ако користите Висуал Студио Цоде (ВС Цоде), нема потребе да сваки пут неуморно куцате граничнике коментара. ВС Цоде има уграђену функцију пречице која штеди секунде (па чак и минуте) вашег времена.
можете ли променити име надгледања
Пречица за брзи ВС код коментара
За оне који су у журби, ево ваше златне карте:
- За коментар у једном реду користите комбинацију тастера Цтрл + / на Виндовс-у или Линук-у или Цмд + / на Мац-у.
, - За блок коментар користите Схифт + Алт + А на Виндовс-у или Линук-у или Схифт + Оптион + А на Мац-у.
, - Да бисте коментарисали код, можете да притиснете Цтрл + К + Ц на Виндовс-у или Цмд + К + У на Мац-у.
,
Већина кодера много коментарише. И не ради се само о остављању стварних коментара, већ што је можда још важније, ви ћете коментарисати и декоментарисати код. Ово је изводљиво за тестирање, експериментисање и отклањање грешака.
Пречице су ту да ово учине укуснијим. Они убрзавају навигацију и измене, дозвољавајући вам да мењате коментаре без ометања замаха кодирања.
Коментаришући изван основа
Иако су основне пречице прави поклон, има још много тога да се коментарише ВС Цоде. Хајдемо дубље:
Тоггле Цомментс
Најбољи део пречица за коментаре ВС Цоде је њихова функција пребацивања. Не морате да се петљате око и ручно уклањате сваки маркер коментара ако се предомислите (или током отклањања грешака). Уместо тога, само користите исте пречице. Са истим комбинацијама тастера, можете брзо да прелазите између кода са коментарима и кода без коментара да бисте остали организовани када вам је то најпотребније.
Коментаришући више редова
Ако треба да искључите дугачак блок кода или оставите опширан, детаљан коментар, не желите да трошите време на мукотрпно додавање коментара ред по ред. Уместо тога, можете да изаберете линије које желите да деактивирате и користите пречицу за коментаре да бисте дозволили ВС Цоде-у да убаци коментаре у сваки ред.
Нестед Цомментс
Понекад, уметање коментара у блок кода може довести до неочекиваних резултата и грешака ако се граничници не поклапају баш добро. Овде вам може помоћи Интеллисенсе Висуал Студио Цоде-а. Он ће вам прилагодити формат коментара чак и унутар блока који је већ коментарисан, тако да неће бити сукоба са угнежђеним коментарима.
Проширења за Суперцхарге коментарисање
ВС Цоде је уређивач отвореног кода који служи као платформа за програмере да изнесу своје најбоље проширења. Тржиште је препуно екстензија које ће вам дати више снаге и корисности када коментаришете:
Беттер Цомментс
Коментирање може изгледати као мали и опциони део кодирања, али постоји толико много креативних начина за коришћење коментара. Тхе Беттер Цомментс проширење вам помаже да додате сврху и јасноћу коментарима које посипате тако што ћете их категоризовати у упозорења, упите, ТОДО-е и друге категорије. И то је све са додатним бонусом кодирања боја за побољшану видљивост и организацију. Ваши коментари постају смернице и сепаратори који ваш код чине уреднијим и приступачнијим.
Цоммент Анцхорс
Цоммент Анцхорс одржава вас укорењеним у свом коду помоћу тачака које разликују делове или битна места у њима. Ако испробате ово проширење, омогућиће вам да брзо пронађете прецизне белешке и примедбе. Ако је ваш пројекат огроман и ваш код постаје натрпан и тешко га је пратити, то би га могло учинити много сварљивијим.
полисхцоде
полисхцоде трансформише ваш код и коментаре у визуелно занимљиве, лако читљиве слике за дељење које су савршене за друштвене медије. Омогућава вам да промените величину, означите боју, промените позадину и још много тога. Имате користи од веће читљивости, а сви саиграчи могу много лакше да сарађују и деле увиде.
Зашто коментарисати?
Коментирање није само оквир за квачицу или неки необавезни посао који раде разнородни људи; то је саставни део кодирања. Ево неких од разлога за то:
како избрисати све сачуване лозинке у цхроме-у
Јасноћа
Кодери настоје да неухватљиво учине разумљивим. Писање кода који функционише понекад може бити једноставније од писања кода који је лако разумети и пратити. Коментари су компас програмера – непроцењива помоћ за навигацију у пространствима кода, било да су лагани и млади или густи и зрели. Можда имате посла са замршеним алгоритмима или скривеним пословним процесима. У сваком случају, коментари пружају познату рукохвату у мору сложености.
Сарадња
Коментари су згодни када сте соло програмер. Али они су неопходни када радите као тим ако желите да ваш пројекат напредује. У оквиру заједничких напора, коментари омогућавају да више програмера неприметно раде заједно чак и када нису у интеракцији. Чланови тима могу да објасне код и поделе своје мисаоне процесе и образложење иза својих одлука. Ово служи као мост који омогућава свима да буду на истој страни и са пројектом и са другима.
Отклањање грешака
Ако откријете да поново прегледавате стари код или покушавате да отклоните грешке у нечему што вас збуњује, коментари постају ваша спасоносна милост. Они воде евиденцију о вашој прошлој логици и мисаоном процесу који вас може указати на могућу погрешну логику и може вас одвести назад до порекла грешке. Са овим подсетником о томе где сте били у прошлости, можете да вратите проблематичне промене, оптимизујете старији код и вратите се на прави пут.
Савети за ефикасно коментарисање
Сада знате како да користите пречице за коментаре, имате неке згодне додатне екстензије и разумете сценарије када је коментарисање најкорисније. Све што вам преостаје је да размотрите неке најбоље праксе за коментарисање и завршићете курс за коментаре кодирања.
Будите концизни
Постоји уметност у остављању сажетих, лако сварљивих коментара. Оставите само толико да себи или члановима вашег тима дате праву идеју, али не толико да будете неодољиви. Свака реч вашег коментара треба да има сврху и да помогне у изградњи поруке коју покушавате да пренесете. Ако је ваш коментар сувише кратак, можда неће успети да пренесе своју поруку, али ако је предугачак, већа је вероватноћа да ћете га прескочити или ћете га збунити у будућности.
гоогле плаи је запео на преузимању на чекању
Избегавајте очигледне коментаре
Релевантност би требало да буде ваша примарна брига у креирању јасног и разумљивог кода. Ако већ напишете свој код тако да је његово значење очигледно, нема потребе да помињете нешто што се може видети на први поглед. Пустите код да говори кад год може и користите коментаре да додате додатни контекст или пружите нове перспективе.
Користите коментаре за „Зашто“, а не „Шта“
Ваш кодекс излаже чињенице о томе шта се дешава. Али коментари могу испричати дубљу причу. Они преносе мотивацију и мисаоне процесе иза ваших одлука. Зашто сте изабрали овај алгоритам уместо другог? Које су замке требале имати на уму? Можда сте испробали неки код који би многи препоручили, али није функционисао или није добро радио. Добро осмишљеним коментарима можете пренети много више од пуких упутстава.
Остављање коментара
Функција коментарисања ВС кода могла би бити више од погодности. Ако га у потпуности искористите, разлика у навигацији и разумљивости ваше базе кода може бити огромна. Допуњен паметним проширењима и темељном стратегијом, ускоро бисте могли да креирате добро документован код који се чита као ремек-дело.
Да ли остављате много коментара да бисте објаснили свој код? Или углавном користите коментаре да бисте искључили неисправан или експериментални код из програма за отклањање грешака? Реците нам своју причу у коментарима испод. Они су ту да остану.