У овом чланку ћете сазнати више о коментарима Котлина и зашто и како их користити.
У програмирању, коментари су део програма намењен вама и вашим колегама програмерима да бисте разумели код. Компајлер Котлин (Компилер) их потпуно игнорише.
Слично као и Јава, у Котлину постоје две врсте коментара
/*… */
//… .
Традиционални коментар / *… * /
Ово је вишередни коментар који може да се протеже у више редова. Компајлер Котлин игнорише све од /*
до */
. На пример,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Традиционални коментар се такође користи за документовање Котлиновог кода (КДоц) са мало варијација. КДоц коментари почињу са /**
и завршавају се са */
.
Коментар на крају реда //
Компајлер игнорише све од //
до краја реда. На пример,
// Котлин Хелло Ворлд Програм забава главна (аргс: Арраи) (принтлн ("Хелло, Ворлд!") // на екрану приказује Хелло, Ворлд!
Горњи програм садржи два коментара на крају реда:
// Програм Котлин Хелло Ворлд
и
// излази Хелло, Ворлд! на екрану
Користите коментаре на прави начин
Коментари не би требало да буду замена за начин објашњавања лоше написаног кода на енглеском језику. Напишите добро структуриран и читљив код, а затим користите коментаре.
Неки сматрају да би код требало да се само-документује, а коментари да буду оскудни. Међутим, морам се у потпуности не сложити с тим (то је моје лично мишљење). Нема ништа лоше у томе што се помоћу коментара објашњавају сложени алгоритми, регуларни изрази или сценарији у којима сте за решавање проблема изабрали једну технику у односу на другу (за будућу референцу).
У већини случајева користите коментаре да бисте објаснили „зашто“, а не „како“ и спремни сте.