Код миризма 163 — Колекция на име

Виждали ли сте някога CustomerCollection?

TL;DR: Не използвайте „колекция“ във вашето име. Твърде абстрактно е за конкретни концепции.

проблеми

• Четивност
• Злоупотреба с абстракция
• „Лошо именуване“

Решения

1. Преименувайте колекцията с конкретно име.

Контекст

Наименуването е много важно.

Трябва да се занимаваме много с колекциите.

Колекциите са невероятни, тъй като не се нуждаят от нули, за да моделират отсъствието.

Празна колекция е полиморфна с пълна колекция.

Избягваме „null“ и „IF“.

Често използваме лоши и неясни имена, вместо да търсим добри имена в MAPPER.

Примерен код

погрешно

foreach (var customer in customerCollection)
{
    // iterate with current customer
}
foreach (var customer in customersCollection)
{
    // iterate with current customer
}

вярно

foreach (var customer in customers)
{
    // iterate with current customer
}

Откриване

[X] Полуавтоматичен

Всички линтери могат да открият лошо име като това.

Това също може да доведе до фалшиви положителни резултати, така че трябва да бъдем предпазливи.

Етикети

• Наименуване

Заключение

Трябва да се грижим за целия си чист код, променливи, класове и функции.

Точните имена са от съществено значение за разбирането на нашия код.

Връзки

Повече информация

Опровержение

Code Smells са само моето мнение.

Кредити

Снимка от Mick Haupt на Unsplash

Законът на Алцхаймер за програмиране: Гледането на код, който сте написали преди повече от две седмици, е като гледане на код, който виждате за първи път.

Дан Хървиц

Тази статия е част от поредицата CodeSmell.