LINUX.ORG.RU

Имена переменных/классов/ и т.д.


0

1

Вопросы: как лучше для понимания кода именовать переменные/классы/define/include (интересует как Вы именуете)?
1.Переменная

а) int someVar;
b) int some_var;
c) int Some_Var;
d) int intSomeVar;
e) свой вариант

1.1 'Временные' переменные К примеру:

void set_var(int _var){var _var;}
Как вы именуете переменную _var ?
2. Класс.
a) class myClass {};
b) class my_class {};
c) class class_myClass {};

3. #define
Насколько я понял, в С/С++ есть некоторое правило, по которому все что записано в #define пишется с большой буквы?

4. Константы.
К примеру есть код
for (double x=x0;x<=xEnd;x+=dx) {...
Как с точки зрения удобства чтение/понимания/отладки лучше записывать x0,xEnd, dx при условии что они не изменяются в коде, то есть константы: в define или в .h файле как static <type> x0=0?
5. Именование кнопок/label
a) butDoSome1; butExit; labProgName (кнопка, кнопка и label)
b) DoSome1; Exit; ProgName
c) Свой вариант

6. Как с точки зрения удобства/читаемости кода оставлять одно- двострочные коды в .h файл?
К примеру:
//my.h
class my
{
 int a;
 int get_a() {return a;}
 void set_a(int _a) {a=_a;}
};

7.Запись в одну строку небольшого кода:
Насколько удобным для других будет такой код:
if (some1) {doSome1();}
if (some2) {doSome2();}
Или все же нужно делать
if (some1)
 {doSome1();}
Сам склоняюсь к 1-ому варианту.
8. Пробелы:
В С/С++ мне удобно писать без 'лишних' пробелов, то-есть
void doSome(int _a, int _b, int _c)
 {a=_a+1; b=_b; c=a+b+_c;}
Некоторые ID ставят пробелы, например напишут 'a = _a + 1; b = _b; c = a + b + _c;'
Как лучше со стороны читаемости/удобства?
9. Небольшой класс/структура/..
К примеру, есть класс (class1), записанный в .h и .cpp файлах. Он использует LittleClass, описание которого занимает 10-15 строчок (если все написать в .h файле), причем littleclass больше нигде в проекте не используется. Есть ли смысл выносить LittleClass в отдельный файл??
10. Комментарии.
Как лучше вставлять однострочные комментарии:
a) // comment
b) /*comment*/
c) /*
comment
*/

11. Как вы оставляете коментарий, что к этому участку кода нужно вернуться и что-то исправить?
Я пишу
do1();
do2(); //fixme
Есть ли общепринятый стандарт?

Интересует в первую очередь С/С++ немного Python, хотя имена переменных не зависят от языка, если отличаются большие/маленькие буквы, другие параметры могут сильно отличатся.

★★★★

Последнее исправление: ymuv (всего исправлений: 3)
Ответ на: комментарий от Miguel

темплейты

Это отдельный случай, ТС про это вообще ничего не писал.

В этом случае, всё равно я против кода в объявлении класса. Код методов в .h можно и ниже написать.

anonymous
()
Ответ на: комментарий от anonymous

В этом случае, всё равно я против кода в объявлении класса. Код методов в .h можно и ниже написать.

А смысл?

Miguel ★★★★★
()
Ответ на: комментарий от Miguel

Наверное чтоб удобно было читать, хотя (мое ИМХО) однострочный код не засоряет код. (если притом написанный в одну строку с методом)

ymuv ★★★★
() автор топика
Ответ на: комментарий от anonymous

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

Miguel ★★★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.