Генераторы словарей и модули Рython
Функции в языке Python Функции в языке PythonВсе функции в языке Python возвращают какое-либо значение, хотя вполне возможно (и часто так и делается) просто игнорировать это значение. Возвращаемое значение может быть единственным значением или кортежем значений,...
Реализация генераторов Реализация генераторовМы рассмотрели коллекции-последовательности, tuple, collections, na-medtuple и list, поддерживающие, как и строки, возможность извлечения срезов. Также было рассмотрено использование оператора распаковывания...
Парсинг документов XML Парсинг документов XMLXML: Для парсинга документов XML широко используются два основных подхода. Один из них основан на анализе DOM (Document Object Model -объектная модель документа), а другой - на использовании SAX (Simple API for XML - упрощенный...
Копирование коллекций Копирование коллекцийКопирование коллекций: Поскольку в языке Python повсюду используются ссылки на объекты, когда выполняется оператор присваивания (=), никакого копирования данных на самом деле не происходит. Если справа от оператора находится литерал,...
Функции в языке Python
Имена и строки документирования: Использование осмысленных имен для функций и их параметров помогает понимать назначение функции другим программистам, а также, спустя некоторое время после создания функции, и самому автору функции. Ниже приводятся несколько основных правил, которых мы рекомендуем придерживаться. Избегайте использовать аббревиатуры в любых именах, если эти аббревиатуры не являются стандартными и не получили широкого распространения.

Соблюдайте разумный подход при выборе имен для переменных и параметров: имя х прекрасно подходит для координаты х, а имя i отлично подходит на роль переменной цикла, но вообще имена должны быть достаточно длинными и описательными. Имя должно описывать скорее назначение элемента данных, чем его тип (например, имя amount_due предпочтительнее, чем имя money), если только имя не является универсальным для конкретного типа данных, например, имя параметра text в функции shorten.

Имена функций и методов должны говорить о том, что они делают или что они возвращают (в зависимости от их назначения), и никогда - как они это делают, потому что эта характеристика может измениться со временем. Все три функции возвращают индекс первого вхождения имени в списке имен, причем поиск в списке начинается с указанного индекса и используется алгоритм поиска, который предполагает, что список уже отсортирован.

Первый случай приходится признать неудачным, потому что имя функции ничего не говорит о том, что будут искать, а имена ее параметров (по всей видимости) указывают на их типы (list, str, int), но ничего не говорят об их назначении. Второй вариант также следует признать неудачным, потому что имя функции описывает алгоритм, использованный первоначально, но с течением времени алгоритм могут изменить.
Навигация: 1 2 3 4
 
 
© Copyright