2015-05-21 5 views
-2

Я читал Руководство по стилю Google C++, чтобы попытаться подражать хорошим правилам кодирования. Когда я прочитал раздел о том, как комментировать мой код, он просит начать каждый файл с license boilerplate. Все, что я мог узнать об этой терминологии, было от Mozilla и что я считаю their commenting standards. Что такое комментарий к шаблону лицензии и какой формат он должен быть?Что такое комментарий к шаблону лицензии и какой формат он должен быть?

Примечание. Чтобы быть ясным, я не говорю, что руководство по стилю Google C++ - это идеальное руководство для правильной практики кодирования. Я просто использую его, чтобы получить новые идеи о том, как улучшить мой стиль кодирования.

+0

Например, [см. Здесь] (https://www.gnu.org/licenses/gpl-howto.en.html) для блока комментариев, связанного с GPL. В нем указаны такие вещи, как авторы, возможность освобождения, кто может изменить код, если люди могут взимать плату за программное обеспечение, разработанное с помощью этого кода, и т. Д. – CoryKramer

+0

Спасибо, например, я не знал, что для коммерческого кода необходим каждый исходный файл, который должен быть документирован с лицензией и соглашениями о сроках. Это имеет смысл, поскольку это интеллектуальная собственность. – Bryan

+0

Руководство по стилю google C++ не считается хорошей практикой во многих частях для современного C++ (но его долгое время с тех пор, как я лично его прочитал). Это считается хорошим стилем для внутреннего кода Google C++, который должен соответствовать текущему коду C++, используемому в google. –

ответ

3

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

+0

Благодарим за краткое описание того, что такое лицензионный шаблон. – Bryan