Komentarze w kodach wybranych programów

• Autorzy: Skhut Sviatoslav , Iholkina Kateryna

Warianty tytułu

EN

Comments in the codes of selected programs

• Języki publikacji: EN

Abstrakty

EN

Writing comments is as important as writing code. The main purpose of using comments is to improve readability of our code but frequently thoughtless comment writing decrease understandability of source code. Comments must be concise and precise simultaneously. Also, when our code is changed, comments for this code must be changed too. While using comments in our code we must realize that if expressiveness of our programming language allows us to express clearly what we want in code, there is no need to write comments at all. And if we decide to use comments, they must be extremely accurate and understandable, because another person must understand, what we do and most importantly, why we do it. Frequently comments can be replaced with good clear names of variables, functions or classes. Also, we can replace our comments with assertions. Comments should clarify and explain our intentions. Copyrights and an authorship can be implemented using comments too. But our IDE can do these things automatically.

Słowa kluczowe

EN

source code; software; software engineering; documentation; software management; code comments

PL

kod źródłowy; oprogramowanie; inżynieria oprogramowania; dokumentacja; zarządzanie oprogramowaniem; komentarze kodu

• Wydawca: Wrocławska Wyższa Szkoła Informatyki Stosowanej "Horyzont"
• Czasopismo: Biuletyn Naukowy Wrocławskiej Wyższej Szkoły Informatyki Stosowanej. Informatyka
• Rocznik: 2018
• Tom: vol. 8, nr 1
• Strony: 24--28
• Opis fizyczny: Bibliogr. 6 poz., rys.

Twórcy

autor

Skhut Sviatoslav

• Wrocławska Wyższa Szkoła Informatyki Stosowanej „Horyzont”, ul. ks. Marcina Lutra 4, 54 - 239 Wrocław

autor

Iholkina Kateryna

• Wrocławska Wyższa Szkoła Informatyki Stosowanej „Horyzont”, ul. ks. Marcina Lutra 4, 54 - 239 Wrocław

Bibliografia

• [1] Sun Microsystems Inc, Java code conventions, 1997
• [2] David Straker, C Style: Standards and Guidelines, 1991
• [3] Bernhard Spuida, The fine Art of Commenting, 2002,Tech Notes, general Series
• [4] Brian W. Kernighan, P. J. Plauger, The elements of programming style, 1978, McGraw-Hill Book Company,
• [5] Robert C. Martin, Clean Code. A Handbook of Agile Software Craftsmanship, 2009, Prentice Hall,
• [6] Dori Reuveni, Kevin Bourrillion, Code Health: to comment or not to comment, 2017, blog post

Uwagi

Opracowanie rekordu w ramach umowy 509/P-DUN/2018 ze środków MNiSW przeznaczonych na działalność upowszechniającą naukę (2019).