Комментарии в коде

В написанный ранее код добавить комментарии

Комментарии — это текст, не влияющий на работу программы, он нужен для того что бы оставить пояснение к написанному вами коду.

Комментарии делают ваш код хорошо читаемым, они помогают не только тем, кто читает ваш код, но и вам самим, так как со временем вы забываете, что делает именно этот код. Для того что бы быстро понять, что делает код комментарии должны быть:

• Коротким, пишите только самое необходимое, но при этом содержательным, он должен четко описать что делает код.
• Уместным не указывайте в комментарии очевидные вещи.
• Актуальным, при переписывании кода не забывайте и переписывать комментарии к нему.

Ниже можно посмотреть примеры кода однострочного и многострочного комментария.

// Это однострочный комментарий Pascal

{

Многострочный комментарий Pascal

}

# Это однострочный комментарий python



# Многострочный комментарий python

# 1 вариант



'''

2 вариант

Это строковый литерал.

Но его можно использовать как

Многострочный комментарий python

'''