Я читал Руководство по стилю Google C++, чтобы попытаться подражать хорошим правилам кодирования. Когда я прочитал раздел о том, как комментировать мой код, он просит начать каждый файл с license boilerplate. Все, что я мог узнать об этой терминологии, было от Mozilla и что я считаю their commenting standards. Что такое комментарий к шаблону лицензии и какой формат он должен быть?Что такое комментарий к шаблону лицензии и какой формат он должен быть?
Примечание. Чтобы быть ясным, я не говорю, что руководство по стилю Google C++ - это идеальное руководство для правильной практики кодирования. Я просто использую его, чтобы получить новые идеи о том, как улучшить мой стиль кодирования.
Например, [см. Здесь] (https://www.gnu.org/licenses/gpl-howto.en.html) для блока комментариев, связанного с GPL. В нем указаны такие вещи, как авторы, возможность освобождения, кто может изменить код, если люди могут взимать плату за программное обеспечение, разработанное с помощью этого кода, и т. Д. – CoryKramer
Спасибо, например, я не знал, что для коммерческого кода необходим каждый исходный файл, который должен быть документирован с лицензией и соглашениями о сроках. Это имеет смысл, поскольку это интеллектуальная собственность. – Bryan
Руководство по стилю google C++ не считается хорошей практикой во многих частях для современного C++ (но его долгое время с тех пор, как я лично его прочитал). Это считается хорошим стилем для внутреннего кода Google C++, который должен соответствовать текущему коду C++, используемому в google. –