Как узнать о принятых стилях кодирования - PullRequest
3 голосов
/ 24 октября 2008

Где прочитать о (лучшем опыте) форматировании исходного кода, для отдельных языков, то есть, каковы соглашения для именования переменных и т. Д., Для отступов и где разместить скобки, как и где включать комментарии и т. Д.

Например, для C Kernighan и книги Ритчи Язык программирования C и Линус Торвальдс Руководство по стилю кодирования ядра Linux или Руководство по стилю Google C ++ и для Perl по крайней мере perlstyle - Руководство по стилю Perl .

Редактировать: Возможно, мне следовало бы спросить: "Как правильно начать со стилями кодирования".

Ответы [ 9 ]

3 голосов
/ 24 октября 2008

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

РЕДАКТИРОВАТЬ: Роб Кам сделал комментарий, что он хочет узнать больше об этих «стартовых соглашений».

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

Если вы действительно начинаете новый проект с новым языком, который раньше не использовали ... тогда вы можете начать с соглашений другого языка, который чем-то похож (например, для нового языка oo вы можете использовать соглашения из Java или Smalltalk) и скорректируйте свои соглашения по мере приобретения опыта для нового языка. Когда я начал программировать на Java, я использовал свои соглашения по кодированию Pascal. Некоторые из соглашений pascal не очень хорошо работали на Java, но со временем я отбросил некоторые старые соглашения и разработал новые.

У С. Лотта возникла идея изучить проект с открытым исходным кодом, написанный на выбранном вами языке. Это хорошая идея, чтобы получить некоторые предложения о хороших соглашениях. У Сриканта была хорошая идея попросить хорошие соглашения здесь, в Stackoverflow. Очень хорошая идея, потому что со временем Stackoverflow станет хорошим справочником для соглашений по кодированию.

1 голос
/ 30 октября 2017

У Microsoft есть справочный документ со своими соглашениями по кодированию, на которые может быть полезно взглянуть, даже если вы не используете C #. Помимо стилей и базовых соглашений, рекомендуемые другими здесь книги по передовым методам, такие как Чистый код , являются важным чтением для создания поддерживаемого, читаемого кода, который будет иметь смысл для будущих сопровождающих вашей кодовой базы.

Если вы используете Visual Studio (и некоторые другие современные IDE), основные несоответствия с рекомендованными соглашениями автоматически подчеркиваются (с предложениями по зависанию в последних версиях VS). В VS, если ваша команда хочет использовать другие стандарты, просто откройте свойства проекта и измените настройки для «Анализ кода» (последний элемент меню слева). Подробнее здесь: Использование наборов правил для группировки правил анализа кода

1 голос
/ 24 октября 2008

Есть три хороших места, чтобы посмотреть.

  1. Популярные книги на языке, который вы используете.
  2. Проекты с открытым исходным кодом, написанные на вашем языке.
  3. Утилиты типа Checkstyle для вашего языка.

Если вы используете такой инструмент, как Checkstyle или PMD, помните, что многие из применяемых ими «правил» могут быть спорными. может быть полезно проверить документацию , чтобы выяснить, какие правила следует опасаться.

1 голос
/ 24 октября 2008

Я бы очень рекомендовал прочитать Чистый код дяди Боба, если вас беспокоят проблемы со стилем кода.

1 голос
/ 24 октября 2008

Я бы использовал Google для этого. Например, для поиска рекомендаций по кодированию Java я буду использовать этот запрос или публиковать в Stack Overflow и спрашивать, каковы рекомендуемые рекомендации по стандартному кодированию для Java. Трудно указать один источник для всех языков.

Я бы посоветовал вам выбрать один для вашей компании / проекта, придерживаться его и убедиться, что это хороший стандарт.

1 голос
/ 24 октября 2008

Что лучше, чем книга, так это найти открытый исходный код на предпочитаемом вами языке.

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

Когда клиента просят помочь со стандартами кодирования, я предпочитаю найти хороший проект с открытым исходным кодом и предоставить краткий документ по стандартам с надписью «Сделайте так, чтобы он выглядел как ххх». Хорошим примером, который я использую для стиля Java, является проект Apache Ant .

У каждого есть свой любимый пример проекта с открытым исходным кодом. Прочитайте реальный рабочий код и выберите любимый. Подражайте этому проекту.

0 голосов
/ 17 июня 2011

Если вы PHP разработчик, эти два руководства не должны быть пропущены:

0 голосов
/ 19 мая 2009

Имеются руководства по стилям C и C ++ , краткая страница ссылок на руководства по стилям, правилам кодирования и обсуждения из USENET, которые ведет Кристофер Лотт.

0 голосов
/ 24 октября 2008

Привет и хорошего дня всем

Ну, я должен сказать, что это зависит Это зависит от того, работаете ли вы в компании или если вы работаете на вас;)

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

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

скобки и прочее - твой путь

но как вы сказали, есть отдельные языки, поэтому у них есть свои правила

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

Вот и все не более .... пока пока

...