什么是许可证样板评论以及它需要采用何种格式?

时间:2015-05-21 20:01:05

标签: c++ coding-style comments boilerplate commenting

我正在阅读 Google C ++风格指南以尝试模拟良好的编码实践。当我阅读有关如何评论我的代码的部分时,它会要求我使用license boilerplate启动每个文件。我能找到的关于这个术语的全部内容来自 Mozilla 以及我认为是their commenting standards的内容。什么是许可证样板评论以及它需要采用什么格式?

注意:要明确,我并不是说Google C ++风格指南是遵循良好编码实践的完美指南。我只是用它来获得有关如何改进编码风格的新想法。

1 个答案:

答案 0 :(得分:3)

“许可证样板”是放置在每个源代码文件开头的注释块,用于描述或命名源代码所在的许可证或术语。如果存在需要使用的特定评论样式,则许可证本身将对其进行描述,否则可以自由使用他们喜欢的任何样式。

相关问题