Правила программирования на С и С++. Главы 7-8 - Не размещайте тела функций в определениях классов

 

115. Не размещайте тела функций в определениях классов.

Здесь есть несколько проблем. Если вы действительно поместите тело функции в определение класса таким образом:

class amanda

{

public:

void peekaboo( void ){ cout ?? "ку-ку\n"; } // функция игры в прятки с Амандой}С++ делает этот класс встроенным. Первая проблема заключается в том, что такие функции с течением времени имеют тенденцию разрастаться и становятся слишком большими, чтобы быть встроенными. Поэтому лучше помещать определения своих встроенных функций вне определения класса, но в том же заголовочном файле, где размещается определение класса: class amanda

{

public:

void peekaboo( void );

}

class amanda::peekaboo( void )

{

cout ?? "ку-ку\n";

}

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

Как только вы начинаете добавлять тела функций, даже если они состоят из одной строки, к определению класса - вы эту ясность теряете. Определение класса начинает распространяться на несколько страниц, и становится трудно найти что-нибудь, используя определение класса в качестве средства документирования.

Третья проблема более коварна и потребует нескольких часов на устранение, если вы не будете аккуратны. Рассмотрим фрагмент реализации связанного списка на листинге 8 (который не будет компилироваться). Классы linked_list и list_node посылают сообщения друг другу. Компилятор должен увидеть определение класса до того, как он позволит вам послать сообщение объекту этого класса. (Вы можете объявить указатель на объект, лишь глядя на class xxx; но вы не можете ничего сделать при помощи этого указателя до завершения определения всего класса). Так как в листинге 8 используются встроенные функции, то невозможно устроить эти определения классов так, чтобы избежать предварительных ссылок. Вы можете решить эту проблему, поместив определения функций в конце того файла, где они объявлены. Я сделал это на листинге 9.

Листинг 8. Фрагмент реализации связанного списка

1. class list_node;
2. class linked_list
3. {
4. int number_of_elements_in_list;
5. list_node *root;
6. private: // этот раздел содержит сообщения, получаемые
7. friend class list_node; // только от объектов list_node
8. void have_removed_an_element(void)
9. {
10. --number_of_elements_in_list;
11. }
12. public
13. void remove_this_node( list_node *p )
14. {
15. // Следующая строка генерирует ошибку при компиляции,
16. // так как компилятор не знает, что list_node
17. // имеет сообщение remove_yourself_from_me( ?root ).
18. p->remove_yourself_from_me( ?root );
19. }
20. // ...
21. };
22. class list_node
23. {
24. linked_list *owner;
25. private: // Этот раздел содержит сообщения,
26. friend class linked_list: // получаемые только от объектов linked_list
27. void remove_yourself_from_me( list_node *root )
28. {
29. // ... Выполнить удаление
30. owner->have_removed_an_element();
31. }
32. };

Листинг 9. Улучшенный вариант реализации связанного списка

1. class list_node;
2. class linked_list
3. {
4. int number_of_elements_in_list;
5. list_node *root;
6. private:
7. friend class list_node;
8. void have_removed_an_element( void );
9. public
10. void remove_this_node( list_node *p );
11. //...
12. };
13. //===============================================================
14. class list_node
15. {
16. linked_list *owner;
17. private: // Этот раздел содержит сообщения,
18. friend class linked_list: // получаемые только от объектов
19. // linked_list
20. void remove_yourself_from_me( list_node *root );
21. };
22. //===============================================================
23. // функции класса linked_list:
24. //===============================================================
25. inline void linked_list::remove_this_node( list_node *p )
26. {
27. p->remove_yourself_from_me( ?root );
28. }
29. //--------------------------------------------------------------------------------------------------------------------
30. inline void linked_list::have_removed_an_element( void )
31. {
32. --number_of_elements_in_list;
33. }
34. //===============================================================
35. // функции класса list_node:
36. //===============================================================
37. void list_node::remove_yourself_from_me( list_node *root )
38. {
39. // ... Выполнить удаление
40. owner->have_removed_an_element();
41. }