本页面记录了 isocpp.org 博客文章所用的编辑规范。
基本格式
博客文章的基本格式通常如下:
一些简短的介绍性文字。
(引用 + 标题 3 样式)文章标题,带外部内容链接
(引用样式)作者姓名
摘自文章
(引用样式)文章中一些有趣的段落,可以短至一行,也可以是一到两段。对于 StackOverflow 问题,我们通常会包含大部分问题(如果是长问题,则只包含关键部分)。
一般注意事项:请记住使用两个连字符(没有空格的“--”)来表示破折号,并使用“代码行”按钮将代码字体应用于文本段落中的关键字等。
博客“标题”字段
使用句子大小写,但书籍/文章/视频标题使用标题大小写。如果存在作者,则追加“--”和作者的全名(名和姓)。
对于 StackOverflow 问题,我们通常会为了清晰和语法略微改写问题。
错误提示:< 和 > 字符在标题字段中尚不能正确显示。目前请明确使用<
和>
。希望这种情况很少见(除了 Howard Hinnant 已经遇到过一个包含“vector<bool>
”的标题)。
示例
Casablanca: C++ on Azure -- John Azariah | 标题使用标题大小写(和姓名) |
秋季 WG21 会议:请在 9 月 14 日星期五之前注册 | 没有标题,所以全部使用句子大小写 |
Action Libraries++ 1.51.0 今日发布 | 多词标题,然后回到句子大小写 |
提醒:Bjarne Stroustrup 明天将在德克萨斯州奥斯汀进行直播 | 全部使用句子大小写 |
为什么要爱上 vector<bool>? | 使用 <> 变通方法 |
博客“类别”字段
大多数博客文章将有两个类别:主要类别(例如,文章、视频)加上新闻,以便它们显示在主页顶部的“近期亮点”部分。(我们通常只在单个标准化论文上省略新闻类别。如有疑问,请添加新闻。)
标签
至少选择一个标签,例如“基础”或“中级”来指定文章的级别。
代码
代码块请使用代码块样式。它们将以带阴影和语法高亮的代码字体呈现。
对于普通文本段落中的代码(例如关键字),请使用代码行/内联代码样式。它们将仅以代码字体呈现(无阴影或语法高亮),以便更好地与文本内联。
图形
通常最好(尽管不是必需)在文章中包含高质量的图片。通常只需几秒钟使用截图工具(例如 Windows 自带的截图工具;只需按下 Windows 键 +“snip”+ Enter 即可快速启动它)截取作者、站点徽标或与文章相关的其他图像。只需将图像保存到计算机上的临时本地目录,然后在博客编辑器中将光标移动到编辑窗口的开头(以便图像将插入到文章顶部),然后单击“插入快速图像”工具栏按钮并输入文件名即可将图像插入到文章中。就是这么简单,它极大地增加了文章的视觉吸引力。