Главная » C++ » Что конкретно представляет собой шаблон комментария лицензии и в каком формате он должен быть?
Что конкретно представляет собой шаблон комментария лицензии и в каком формате он должен быть?
Я читал через Руководство по стилю Google C ++ попытаться подражать хорошим практикам кодирования. Когда я читаю раздел о том, как комментировать мой код, он просит меня начать каждый файл с лицензионный образец. Все, что я мог узнать об этой терминологии, было от Mozilla и что я считаю их стандарты комментирования. Что конкретно представляет собой шаблон комментария лицензии и в каком формате он должен быть?
Примечание. Чтобы быть ясным, я не говорю, что руководство по стилю Google C ++ — это идеальное руководство для правильной практики кодирования. Я просто использую его, чтобы получить новые идеи о том, как улучшить мой стиль кодирования.
«Образец лицензии» — это блок комментария, помещаемый в начале каждого файла исходного кода, который описывает или называет лицензию или условия, в которые был помещен исходный код. Если существует определенный стиль комментирования, который требуется использовать, тогда сама лицензия будет описывать его, в противном случае можно использовать любой стиль, который им нравится.
Я читал через Руководство по стилю Google C ++ попытаться подражать хорошим практикам кодирования. Когда я читаю раздел о том, как комментировать мой код, он просит меня начать каждый файл с лицензионный образец. Все, что я мог узнать об этой терминологии, было от Mozilla и что я считаю их стандарты комментирования. Что конкретно представляет собой шаблон комментария лицензии и в каком формате он должен быть?
Примечание. Чтобы быть ясным, я не говорю, что руководство по стилю Google C ++ — это идеальное руководство для правильной практики кодирования. Я просто использую его, чтобы получить новые идеи о том, как улучшить мой стиль кодирования.
Решение
«Образец лицензии» — это блок комментария, помещаемый в начале каждого файла исходного кода, который описывает или называет лицензию или условия, в которые был помещен исходный код. Если существует определенный стиль комментирования, который требуется использовать, тогда сама лицензия будет описывать его, в противном случае можно использовать любой стиль, который им нравится.
Другие решения