Причины не использовать макросы для уменьшения определения функции

Question

Причины не использовать макросы для уменьшения определения функции

0

Предположим, у меня есть класс

template
<
  typename ValType,
  typename SizeType        = size_t,
  typename ReservePolitics = double_size
>
class buffer {
public:

    buffer();
    buffer(dimension const& dim);

    // lots of functions ...

};

с функциями, определенными вне этого:

template
  <
    typename ValType,
    typename SizeType        = size_t,
    typename ReservePolitics = double_size
  >
buffer<ValType, SizeType, ReservePolitics>::
  buffer() : _Cap(), _Ptr(nullptr), _ResPol() {}

template
  <
    typename ValType,
    typename SizeType        = size_t,
    typename ReservePolitics = double_size
  >
buffer<ValType, SizeType, ReservePolitics>::
  buffer(dimension const& dim) :
    _Cap(), _Ptr(nullptr), _ResPol() { /*...*/ }

// lots of definitions ..

Эти определения трудно читать. Но я могу определить несколько макросов

#define BUFFHEADER\
  template\
  <\
    typename ValType,\
    typename SizeType      = size_t,\
    typename ReservePolitics = double_size>\
  >

#define BUFFINSTANCE buffer<ValType, SizeType, ReservePolitics>

#define BUFFNAMESPACE BUFFINSTANCE::

что помогает мне уменьшить эти определения:

BUFFHEADER BUFFNAMESPACE
  buffer() : _Cap(), _Ptr(nullptr), _ResPol() {}

BUFFHEADER BUFFNAMESPACE
  buffer(dimension const& dim) :
    _Cap(), _Ptr(nullptr), _ResPol() { /* ... */ }

Есть ли причины не делать этого и вводить объявление отверстия с template<... каждый раз?

wowofbob 12 нояб. 2014, в 23:14

Источник

2

не уверен, что это допустимо повторять значения параметров шаблона по умолчанию в каждом определении, но в любом случае не делайте этого
Cheers and hth. - Alf 12 нояб. 2014, в 21:29
3

Вам нужно определить методы в заголовочном файле, иначе вы получите ошибки компоновщика. Так что просто сделайте это в определении класса, и у вас нет этой проблемы. Почему вы определяете методы вне класса?
clcto 12 нояб. 2014, в 21:31
0

Конечно, все это правильно определено в шапке. Нет такого вопроса, если все определено внутри класса. Я сделал это, чтобы сделать объявление класса более читабельным.
wowofbob 12 нояб. 2014, в 21:32
0

«Могу ли я использовать макросы» - да, вы можете. Тебе следует? Возможно нет.
cdhowie 12 нояб. 2014, в 21:34
0

«Могу ли я использовать макросы ...» Вы можете использовать макросы, чтобы запутать все и вызвать неожиданные побочные эффекты, как вам нравится.
πάντα ῥεῖ 12 нояб. 2014, в 21:35
0

@clcto Я соблазнился сделать это сам. Иногда приятно видеть все объявления вместе без определений как своего рода обзор классов.
Mark Ransom 12 нояб. 2014, в 21:36
6

Причины, по которым ничего не нужно делать, включают в себя то, что ваш код будет труднее читать, труднее поддерживать, меньше использовать повторно и более подвержен ошибкам. Причины для того, чтобы что-то сделать, - сделать ваш код более легким для чтения, более легким в обслуживании, более пригодным для повторного использования и менее подверженным ошибкам. Так что подумайте о том, что вы делаете, выясните, действительно ли это вам помогает, затем примите собственное решение. Делайте то, что больше всего подходит для вашей ситуации.
Jason C 12 нояб. 2014, в 21:38
1

В дополнение к отличному комментарию @ JasonC я обнаружил, что макросы в вашем примере отвлекают от читабельности, даже если они намного проще, чем образец шаблона. Я бы просто использовал копирование / вставку вместо этого.
Mark Ransom 12 нояб. 2014, в 21:45
2

Теперь я вижу, что это вопрос, основанный на мнении. Во всяком случае, мне нужно было опытное мнение об этом. Спасибо!
wowofbob 12 нояб. 2014, в 21:54
0

@MarkRansom, что если объединить BUFFHEADER и BUFFNAMESPACE в #define DEFINITION BUFFHEADER BUFFNAMESPACE и использовать его вместо этого? Похоже, что читаемость является проблемой выбора имени здесь.
wowofbob 12 нояб. 2014, в 22:02
1

Это не просто проблема выбора имени, это целый ряд вещей. Вы удалили синтаксические подсказки, которые говорят вам, что это за вещь и почему она необходима. И общее соглашение о том, что макросы должны быть написаны заглавными буквами, хотя и полезно, в конечном итоге делает код ужасным.
Mark Ransom 12 нояб. 2014, в 22:11

Показать ещё 9 комментариев

Теги:

c++

templates

macros

2 ответа

2

Макросы - мощный инструмент, но он может нести к ужасно неясному (трудно понять и отлаживать) код.

Макросы могут работать корректно и не работать в других ситуациях, поэтому их обычно необходимо писать со специальными правилами (с использованием скобок и т.д.).

Большинство применений макросов имеют лучший, безопасный и эквивалентный способ сделать то же самое.

Макросы помогают сделать код короче, но это обычно не означает, что его легче читать и компилировать. Короче! = Лучше

Вот почему макросы являются одним из таких методов, как goto/labels, break/continue, return abuse и т.д., Которые программисты имеют тенденцию запрещать.

Макросы могут по-прежнему быть полезными для некоторых очень специфических целей, но их следует избегать, если нет веских оснований для их использования. Это должно ответить на ваш вопрос.

Adrian Maire 12 нояб. 2014, в 20:26

Ещё вопросы

не уверен, что это допустимо повторять значения параметров шаблона по умолчанию в каждом определении, но в любом случае не делайте этого
Вам нужно определить методы в заголовочном файле, иначе вы получите ошибки компоновщика. Так что просто сделайте это в определении класса, и у вас нет этой проблемы. Почему вы определяете методы вне класса?
Конечно, все это правильно определено в шапке. Нет такого вопроса, если все определено внутри класса. Я сделал это, чтобы сделать объявление класса более читабельным.
«Могу ли я использовать макросы» - да, вы можете. Тебе следует? Возможно нет.
«Могу ли я использовать макросы ...» Вы можете использовать макросы, чтобы запутать все и вызвать неожиданные побочные эффекты, как вам нравится.
@clcto Я соблазнился сделать это сам. Иногда приятно видеть все объявления вместе без определений как своего рода обзор классов.
Причины, по которым ничего не нужно делать, включают в себя то, что ваш код будет труднее читать, труднее поддерживать, меньше использовать повторно и более подвержен ошибкам. Причины для того, чтобы что-то сделать, - сделать ваш код более легким для чтения, более легким в обслуживании, более пригодным для повторного использования и менее подверженным ошибкам. Так что подумайте о том, что вы делаете, выясните, действительно ли это вам помогает, затем примите собственное решение. Делайте то, что больше всего подходит для вашей ситуации.
В дополнение к отличному комментарию @ JasonC я обнаружил, что макросы в вашем примере отвлекают от читабельности, даже если они намного проще, чем образец шаблона. Я бы просто использовал копирование / вставку вместо этого.
Теперь я вижу, что это вопрос, основанный на мнении. Во всяком случае, мне нужно было опытное мнение об этом. Спасибо!
@MarkRansom, что если объединить BUFFHEADER и BUFFNAMESPACE в #define DEFINITION BUFFHEADER BUFFNAMESPACE и использовать его вместо этого? Похоже, что читаемость является проблемой выбора имени здесь.
Это не просто проблема выбора имени, это целый ряд вещей. Вы удалили синтаксические подсказки, которые говорят вам, что это за вещь и почему она необходима. И общее соглашение о том, что макросы должны быть написаны заглавными буквами, хотя и полезно, в конечном итоге делает код ужасным.

NO_NAME · Accepted Answer · 2014-11-12T20-47-00.000Z

Эти макросы должны работать нормально. Тем не менее, я советую не использовать их.

Хорошо, код более краткий и, вероятно, легче читать для вас. Тем не менее, это будет запутать для всех, кто прочитает ваш код. Даже если вы не хотите показывать какой-либо код, вы не должны использовать макросы. Вы узнаете, как читать код шаблона, если вы даете себе некоторое время. Макросы только мешают вам в этом.

Лучший способ сделать код более понятным - это изменить стиль разрывов строк. Если вы устраните хотя бы несколько строк, код будет более понятным, потому что вы сможете увидеть больше кода одновременно. Для каждой скобки вам не нужна новая строка.

Более того, макросы причудливы. Как правило, вы не должны использовать их. @Adrian Maire написал больше об этом в сообщении выше.

Я думаю, что кто-то не перепутал бы слишком совпадение, если бы он прочитал заголовочный файл с использованием макросов, определенных и определенных только в этом заголовке. Когда большие шаблоны пишутся короче, они выглядят ужасно.
@wowofbob Я знаю по своему опыту, что почти никто не читает весь файл. Обычно просто читайте определения одной функции. Конечно, каждый может найти макрос. Их не сложно понять, но это не главное. Просто проще читать знакомую структуру кода. Не нужно даже удивляться, если их смысл. Кроме того, есть еще аргумент, что вы должны научиться читать макрос.
@wowofbob "они выглядят безобразно" Я согласен, но это цена использования макросов.
Итак, суть в том, что если кто-то хочет прочитать и понять, что я сделал, он должен выучить синтаксис, который я использовал с помощью макросов. Это может сбивать с толку. Я вижу это сейчас.