Брзи коментари: Како их користити и зашто?

У овом чланку ћете научити о Свифт коментарима, зашто и како их користити.

Коментар је објашњење или напомена читљива програмеру у изворном коду програма. Компајлер га игнорише када се код компајлира.

Коментари су намењени особи која чита код како би боље разумела намеру и функционалност програма. Може бити корисно док радите у тиму како бисте разјаснили сврху кода за друге чланове тима или док радите искључиво може деловати као подсетник на то.

Брзи коментар и његове врсте

Убрзо постоје две врсте коментара:

1. Једноредни коментар

У Свифту је свака линија која почиње са две косе црте коментар //у једном реду //. Компајлер занемарује све што почињу са двије косе црте .

Једноставан пример можете пронаћи на врху игралишта:

 //: Игралиште - именица: место где се људи могу играти

Почиње са две косе црте //и даје суштинско објашњење датотеке као „Плаигроунд - именица: место на којем људи могу да се играју“.

Пример 1: Једноредни коментар

 //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)

Горњи пример садржи два једноредна коментара:

 // Пример програма // чува 3.14 у променљивој пи

2. Вишередни коментар

Ако ваш коментар садржи више редова, можете га приложити унутра /*… */.

Вишередни коментари почињу косом цртом праћеном звездицом ( /*) и завршавају звездицом праћеном косом цртом унапред ( */). Све између /*и */брзи компајлер игнорише.

/ * Ово је вишередни коментар. Након што напишете вишередни коментар, додајте *, следећи до / да бисте га завршили * /

Пример 2: Вишередни коментар

 /* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)

Горњи пример садржи вишередни коментар.

/ * Тврдо кодирана вредност пи може бити мање тачна. Тако можете израчунати користећи уграђене типове података за тачнију вредност * /

Ствари које треба памтити

Иако су коментари значајни за боље разумевање намере написаног кода. Ево неких ствари које морате узети у обзир приликом писања:

  1. Не прилажите коментаре са // на вишередним линијама, иако је тачна и компајлер их игнорише. Уместо тога, затворите га у вишередни коментар /*… */
    Пример: 
    // Ово је коментар. // Користите га када је потребно и прецизно
    Горњи начин за писање коментара је тачан, али се не препоручује јер морате да пишете вишередне коментаре ако је коментар већи од једног реда. Бољи начин писања је коришћење вишередних коментара као: 
    / * Ово је коментар. Користите га када је потребно и прецизно * /
  2. Коментар у једном реду може се написати у засебном реду или заједно са кодом у истом реду. Међутим, препоручује се коришћење коментара у посебном реду.
    Пример: 
     нека пи = 3.14159 // чува 3.14 у променљивој пи
    Овај начин писања коментара је валидан. Али боље је коментар написати у засебном реду као: 
     // чува 3,14 у променљивој пи лет пи = 3,14159
  3. Чак и ако сте један програмер у тиму, а ви једини пишете код, ако је некоментарисан, тешко ћете покушати да схватите његову сврху у програму. Дакле, користите га прецизно и пружите смислен опис.
  4. Нека коментар буде врло једноставан и смислен.
  5. Не пишите непотребне коментаре на свој код.
  6. У већини случајева користите коментаре да бисте објаснили „зашто“, а не „како“.

Занимљиви Чланци...