Вопрос

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

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

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

Это было полезно?

Решение

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

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

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

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

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

Другие советы

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

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

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

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

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

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

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

Есть три хороших места для поиска.

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

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

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

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

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

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

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

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

    скобки и прочее - это ваш путь

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

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

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

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

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

    Лицензировано под: CC-BY-SA с атрибуция
    Не связан с StackOverflow
    scroll top