Правила именования функций

Илья Лебедев (Devman) @ Python Junior Meetup №1

"Правильно называть сущности очень важно. Плохие названия превратят хороший код в плохой и нечитаемый. В докладе я расскажу о практиках, которые помогут начинающим разработчикам. Их легко применять на практике и они делают код заметно качественнее".

Transcript

1. Как называть функции Илья Лебедев
2. handleContent() visetiPolsovatel() f()
3. Дисклеймер
4. Зачем это всё • сделать код читаемее; • поселить контекст в код; • помогает найти проблемы декомпозиции; • нельзя просто "взять и прочитать код"; • нельзя сказать "ну у меня работает и всё".
5. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
6. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
7. • saveArticleToDatabase() • repo._pull_from_github() • user_banned() • has_account_binded()
8. • saveArticleToDatabase() • repo._pull_from_github() • user_banned() • has_account_binded()
9. • save_article_to_database() • repo._pull_from_github() • user_banned() • has_account_binded()
10. • save_article_to_database() • repo._pull_from_github() • user_banned() • has_account_binded()
11. • save_article_to_database() • repo.pull_from_github() • user_banned() • has_account_binded()
12. • save_article_to_database() • repo.pull_from_github() • user_banned() • has_account_binded()
13. • save_article_to_database() • repo.pull_from_github() • is_user_banned() • has_account_binded()
14. • save_article_to_database() • repo.pull_from_github() • is_user_banned() • has_account_binded()
15. • save_article_to_database() • repo.pull_from_github() • is_user_banned() • has_account_binded()
16. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
17. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
18. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
19. • f() • sv() • send()
20. • f() • sv() • send()
21. • render_intro_slide() • sv() • send()
22. • render_intro_slide() • sv() • send()
23. • render_intro_slide() • save_user_to_database() • send()
24. • render_intro_slide() • save_user_to_database() • send()
25. • render_intro_slide() • save_user_to_database() • send_restore_password_email()
26. • render_intro_slide() • save_user_to_database() • send_restore_password_email()
27. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
28. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
29. build_roof() 01. 02. 03. 04. 05. 06.
30. def build_tower(game): build_first_floor_walls() build_doors() build_roof() build_hatch() ) 01. 02. 03. 04. 05. 06.
31. def build_tower(game): # чтобы построить башню надо: build_first_floor_walls() # построить стены build_doors() # добавить двери build_roof() # построить крышу build_hatch() # прорезать люк ) 01. 02. 03. 04. 05. 06.
32. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
33. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные; • без антипаттернов; • без сокращений.
34. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные (но не слишком); • без антипаттернов; • без сокращений.
35. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные (но не слишком); • без антипаттернов; • без сокращений.
36. • user() • get_movie_info() • handle()
37. • user() • get_movie_info() • handle()
38. • ban_user() • get_movie_info() • handle()
39. • ban_user() • get_movie_info() • handle()
40. • ban_user() • fetch_movie_info() • handle()
41. • ban_user() • fetch_movie_info() • handle()
42. • ban_user() • fetch_movie_info() • generate_report()
43. • ban_user() • fetch_movie_info() • generate_report()
44. Антипаттерны при названии функций • названия без глаголов; • начинать всё с get_ ; • только общие глаголы.
45. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные (но не слишком); • без антипаттернов; • без сокращений.
46. Какими должны быть названия функций • по стандартам; • по-английски; • объясняющие, что функция делает; • объясняющие, зачем функция это делает; • длинные (но не слишком); • без антипаттернов; • без сокращений.