跳转至内容

C++ 编程 Wikibook 约定

来自 Wikibooks,开放世界中的开放书籍

采纳规则

[编辑 | 编辑源代码]

除非此处另有说明,否则作为一般规则,Wikibooks:风格手册中的所有指南均有效。

以下约定是 C++ 编程书籍的本地风格手册,旨在为项目提供稳定性和一致性。

页面命名和结构

[编辑 | 编辑源代码]

我们使用Wikibooks:命名策略中描述的“斜杠约定”。
建议:绝不 有争议 --Panic (讨论) 2010年7月27日 (UTC) 10:32 已更改:基于实际设置 --Panic (讨论) 2010年7月27日 (UTC) 10:32

多面一书

[编辑 | 编辑源代码]

有两个索引:一个章节版本和一个全部内容版本(通过转录)。新页面应同时列在C++ 编程/所有章节[ 编辑 ]索引和C++ 编程索引中。

页面大小

[编辑 | 编辑源代码]

从主页面索引的章节应在一个页面上。但是,单个页面大小不应超过约 30k。较大的页面应拆分。

使用专门主题

[编辑 | 编辑源代码]

通过添加内容,帮助我们为本书提供一些结构,为此,请尽可能创建更多不同的独立章节/部分和子部分,使用独特的(如果可行)专门主题,以便让读者对语言有最完整和逻辑的理解,您还可以添加空的章节/部分,以便未来的贡献者可以添加内容。

作者部分

[编辑 | 编辑源代码]

每个对本书进行非琐碎更改的人员都可以在作者部分添加自己。这可以通过添加您的姓名/别名并包含到您的维基媒体页面、网页或可联系的活动电子邮件地址的链接来完成。

建议:2005年9月19日 投票:2005年9月21日 移至采纳:--Panic 2006年1月17日 (UTC) 04:24

一级标题编号

[编辑 | 编辑源代码]

我们使用一级标题(=标题=)表示各个部分。为了允许转录,主要子模块应始终以最多一个二级标题(==标题==)开头。

建议:2005年9月20日 无争议移至采纳:--Panic 2006年1月17日 (UTC) 04:24

源代码风格

[编辑 | 编辑源代码]

为了允许从其他来源采用,本书中的代码示例没有强制的大括号/缩进风格。但是,请在一个示例中保持一致。

没有采用单一的风格标准(例如:大括号风格),以便于更轻松地导入任何其他代码片段,它也向读者展示了他们可以做出的所有选择,因此您可以使用您喜欢的风格并修改本书中任何现有的代码,但作者无需遵循特定的风格。

常见编程错误

[编辑 | 编辑源代码]

应在整本书中指出常见的编程错误。

建议:2005年9月18日 无争议移至采纳:--Panic 2006年1月17日 (UTC) 04:24

注释框

[编辑 | 编辑源代码]

注意框

[编辑 | 编辑源代码]

注意
使用模板作为通知,向读者提供额外/非标准/常见做法的通知。

{{NOTE|使用模板作为通知,向读者提供额外/非标准/常见做法的通知。}}

建议:2004年11月27日 无争议,移至采纳:--Panic 2006年1月17日 (UTC) 04:24

待办事项框

[编辑 | 编辑源代码]
Clipboard

待办事项
文本中应该包含TODO框,告知读者此处需要填写内容。


{{TODO|文本中应该包含TODO框,告知读者此处需要填写内容。|C++ 编程}} :可以添加用户名的附加参数。(自定义待办事项列表)

建议:2005年9月18日 未引起争议,移至采纳:--Panic 2006年1月17日 (UTC)04:24

本书使用美式英语

[编辑 | 编辑源代码]

为保持一致性,应尽可能使用美式英语。

建议:--Panic 2008年7月31日 (UTC)02:20 未引起争议移至采纳:--Panic (讨论) 2008年8月10日 (UTC)06:03

本书偏好使用连字符

[编辑 | 编辑源代码]

应优先使用连字符(即如果可能就使用)。连字符旨在帮助理解。

建议:--Panic 2009年8月21日 (UTC)19:11 未引起争议移至采纳:--Panic (讨论) 2010年6月20日 (UTC)01:07

建议的问题有效期为7天

[编辑 | 编辑源代码]

如果一个建议的问题在7天内未被质疑、争论或修改,则应将其从建议部分移至采纳部分。

建议:--Panic 2006年1月17日 (UTC)05:02 未引起争议移至采纳:--Panic 2006年3月4日 (UTC)03:48

[编辑 | 编辑源代码]

本书将只包含一个印刷版本,该版本可能包含按章节划分的子部分。

建议:--Panic 2008年4月10日 (UTC)00:05 未引起争议移至采纳:--Panic (讨论) 2008年7月19日 (UTC)17:18

标题/封面

[编辑 | 编辑源代码]

封面将显示书籍的历史索引,并且对封面进行任何重大更改(>51%)都必须经过之前的讨论,并最终达成无异议接受。

建议:--Panic 2008年4月10日 (UTC)00:19 未引起争议移至采纳:--Panic (讨论) 2008年7月19日 (UTC)17:23

华夏公益教科书