mephis
Подумай над правилами составления комментариев к методам и классам. Они должны быть компактными, но в тоже удобными и информативными. Пока пишу так:
Код:
#==============================================================================
# ** RPG::Actor
#------------------------------------------------------------------------------
# Класс с данными актера.
# Примечание: Актеры - это герои, главные действующие лица игры.
#==============================================================================
Код:
#--------------------------------------------------------------------------
# ? Инициализирует переменные класса, присваивает им значения по-умолчанию
# ! Вызывается автоматически при создании нового экземпляра
# класса
#--------------------------------------------------------------------------
def initialize
Примечание тут, возможно, излишне. А, может и нет. Но в любом случае, у метода должно быть описание. Если есть параметры - блок описания их, с учетом принимаемых типов. Тип возвращаемого значения, если оно есть.
Социальные закладки