code source de mise en forme

code standard de formatage, Accord sur le codage en C ++mise en forme correcte du code est vraiment important, si vous voulez que le code soit facilement lisible et compréhensible non seulement pour vous. par exemple, un groupe d'étudiants, qui lisent la même littérature sur la programmation, programmation qui enseigne une seule et même personne, résoudre encore des problèmes de différentes façons. Dans ce cas, chacun avec son propre style de mise en forme de code spécial.

Si vous avez déjà essayé de lire le code des autres, puis notez, vous avez besoin d'un peu de temps, de réorganiser et de commencer à comprendre, Comment ce code et qu'il met en œuvre. Bien sûr, vous pouvez écrire le code de différentes façons, y compris pas tout à fait lisible, et ce qui est le plus intéressant, le programme fonctionne très bien. Voici un aperçu de ce code:

Il est entièrement fonctionnel et aucun problème lors de sa mise en œuvre ne se passe pas. Mais sincèrement désolé que le programmeur, qui « hérité » obtenir le programme, écrit ainsi, et qu'il sera nécessaire au programme d'ajouter quelque chose ou pour l'améliorer. Il est toujours bon, que les variables du programme sont donnés des noms significatifs, pas int, int b. Bien que le programme est très simple, il est très difficile à lire. Une autre chose si elle est écrite en utilisant les règles du formatage du code des normes et des accords sur le codage - avec des espaces, tirets, terme césure, commentaires:

Vous pouvez voir combien plus facile à lire et à comprendre le code est devenu.

presque toujours, plusieurs programmeurs travaillent sur le même programme. Dans ce cas, suivre le programme à l'avenir peut avoir un autre groupe de programmeurs. Il est évident que la création d'une norme de codage unifié. Si les programmeurs adhèrent à ces normes lors de l'écriture de code - tout cela aura le même, qui parfois rendent plus facile de travailler sur des projets de groupe. Souvent, l'entreprise produit elle-même sa propre norme de codage (convention de codage), mais il y a des normes communes. Ceux-ci comprennent, par exemple:

Guide de style de Google C

Normes concernant la codification IBM

style de codage du noyau Linux

Version complète Accord sur le codage en C ++ en anglais ici.

si Voir les statistiques utiliser les normes de mise en forme de code, il devient évident, que la plupart des programmeurs ont plus de travail à faire, et de lutter pour. En effet, plus de la moitié des répondants, ou utilisez votre propre style de codage, ou ne savent pas, pourquoi la mise en forme des normes et des conventions de codage établies.

Parlons des normes et des accords de contenu.

Les principaux objectifs de toutes les normes et conventions de codage est de promouvoir:

-l'écriture de code lisible facilement, compris par tous;

-Writing Secure Code (parce que ces normes ont été créées par les professionnels des programmeurs, qui savent, quelles erreurs peut entraîner une exécution incorrecte d'un code);

-Code edinoobraznogo (dans la structure vseh de code comme vыhlyadyt).

Après avoir examiné plusieurs normes et accords, vous pouvez voir, qui se concentre principalement sur les points suivants:

noms de variables, constantes, fonction, les classes

La principale chose que lorsque vous déclarez une variable (fonctions, classe, etc.) – donner un nom significatif, le plus près possible du contexte d'utilisation. LET, dans votre programme défini par plus de 20 variables, et tout le monde reçoit un nom sous la forme de lettres de l'alphabet. accepter, même vous, le créateur de ce programme,, il sera difficile de travailler avec ces variables. Sans parler du fait, vous devez vous rappeler exactement ce que les magasins de données chaque. Il est beaucoup plus facile de travailler avec des variables, avec des noms valides:

âge - âge;
Numéro - Numéro;
montant – nombre;
nom - le nom.

Il est conseillé d'écrire les noms de pas l'anglais translit, et les mots anglais.

pas vozrast - et l'âge;
pas kolichestvo - et le montant.

Si vous ne connaissez pas la traduction, utiliser l'un des nombreux traducteurs en ligne. En même temps remplir votre vocabulaire. règles, selon lequel sont les noms des variables, Il peut être lu dans notre article Types de données, Constantes et variables dans le C ++.

Константам рекомендуется присваивать имена либо состоящие из букв верхнего регистра (HOURS_IN_DAY, TAILLE) либо каждое новое слово с большой буквы, как Google C++ Style Guide (kHoursInDay). Говоря о константах, их советуют использовать везде, где только можно. Не объявляйте переменные хранящие количество дней в неделе и месяцы в году – объявляйте константные переменные в таких случаях. Относительно функцийесли функция не изменяет аргумент, передаваемый по ссылке или по указателю, то аргумент должен быть константой.

Тогда как для имен переменных используются существительные, для имен функций необходимо использовать глаголы или глагол + существительное. Так правильней потому, что функция выполняет определенное действие:

printData(); – печать данных
enterName(); – ввод имени
showStr(); – показать строку

В имени класса первая буква должна быть заглавной:

class Employee
class Point

Если имя состоит из нескольких слов, написать его можно разными способами.

каждое новое слово с большой буквы (верблюжий регистр): boxWithApple, amountBoxesForSale

использовать нижний прочерк между словами: box_with_apple, amount_boxes_for_sale

Не бойтесь давать сложные имена. В среде Microsoft Visual Studio обращаясь, к объявленной переменной (начиная вводить ее имя), вам будет предложено выбрать имя из выпадающего списка. Давать слишком длинные имена тоже не стоит. Вполне реально отразить суть переменной в нескольких словах.

Сразу хочу рассказать о «венгерской нотации»соглашении об именовании переменных и других идентификаторов в коде программ. Суть «венгерской нотации» в том, что имя переменной (fonctions, массива и т.д.), начинается с префикса, состоящего из одной или нескольких букв. Приведу несколько примеров объявления имен идентификаторов с префиксами:

int iAmount или nAmount,

bool bChoice,

int aNumbers (a говорит о том, что aNumbers – un tableau de),

string sName (rangée),

int* pArr (от слова pointer – aiguille)

Когда мы встретим такое имя в коде, то его префикс будет говорить нам о том, что это за идентификатор и какие данные он хранит.

фигурные скобки

В некоторых соглашениях и стандартах рекомендовано использовать фигурные скобки в блоках if, autre, tandis que, faire, for даже если они содержат всего одну строку либо не содержат ничего. par exemple:

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

пробелы в строке и отступы между строками

Рекомендуется не использовать пробелы в конце строки перед оператором точка с запятой.

При использовании оператора присвоения значения пробелы необходимы с обоих сторон от этого оператора:

Это же касается и операторов используемых в арифметических выражениях:

Применяя унарные операторы, пробелы не нужны:

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

и так без нее:

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

комментирование кода

malheureusement, многие не любят комментировать код, хотя комментарии играют важную роль в поддержании читаемости кода на высоком уровне. Как написано в Google C++ Style Guide «Комментарии важны, но лучше когда код сам говорит за себя. Давать осмысленные имена переменным гораздо лучше, чем давать непонятные названия и затем раскрывать их суть в комментариях»

Оставлять комментарии в коде можно либо используя двойной слэш // (комментирование одной строки), ou /* commentaire */ . Вторым способом можно оформить многострочный комментарий. Но предпочтение авторы некоторых стандартов предлагают отдавать все же комментированию с использованием двойного слэша // .

Каждая функция должна иметь комментарии непосредственно перед ней, которые описывают то, что делает эта функция и как её использовать. par exemple, перед функцией можно написать: // Открывает файл, ou // печатает данные

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

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

Хочу обрадовать тех, кому все же придется столкнуться с кодом, написанным подобно первому листингу в этой статье. В среде разработки Microsoft Visual Studio 2013 Express (peut-être, и в более ранних версиях) est “спасательная комбинация клавишCtrl+K затем Ctrl+F, нажав которую осуществится форматирование выделенного исходного кода. То есть если выделить неотформатированный код и нажать эту комбинацию клавишавтоматически добавятся и необходимые пробелы, и отступы, и скобки перенесутся в отдельные строки. В общем станет код выглядеть, как для людей.

Применяя на практике форматирование кода, описанное в стандартах и соглашениях о кодировании, вы добьетесь и достойной легкой читаемости кода, и его безопасности. Этим вы облегчите работу и себе и коллегам по проекту. peut-être, даже кто-то скажет вам спасибо. А я говорю спасибо моему знакомому – auteur “Блога программистаpro-prof.com за то, что предложил и помог мне написать статью на данную тему.

Bulletin de nouvelles leçons sur la programmation:

code source de mise en forme
5 (100%) 12 votes

3 réflexions sur "code source de mise en forme

  1. important! Наверное следует эту статью читать прежде чем начинать учиться.

Laisser un commentaire

Votre adresse email ne sera pas publiée. les champs requis sont indiqués *