黑盒百科制作文档 v1.1

欢迎大家来到百科攻略社区,我是隔壁主机区的精神支柱东哥~

我在这里给大家分享一下关于百科模版、表格、设计方面的一些规范,望大家周知。

推出制作文档的本意在于方便大家将来对百科的维护,虽然规则繁琐,但是一旦形成习惯,对于日后的发展定是极好的~

黑盒百科制作文档 v1.1

百科模版开发基础

HTML5+CSS3+原生JavaScript,此三编程语言是前端开发中“最最最最基本”的内容,也是黑盒百科现阶段支持的核心工具,足够没有基础的开发者使用。

这三种编程语言的逻辑比C简单得多,有兴趣和基础的筒子很快就能上手。

学习地址:菜鸟教程W3School编程学院 – 全英语计蒜客

开发环境(写代码的工具)概述与推荐

现在互联网开发的环境已经相当成熟,有很多开发者会为其他开发者开发工具,这导致了现在专业的前端开发坑非常巨大,也导致了大家拥有超多的工具可选,眼花缭乱。

现在问题来了,工具多了,但是萌新反而不知道怎么选了,所以这一段主要的目的在于指路,告诉大家最高效的解决方案。

代码编辑器选择:Visual Studio CodeSublime Text 3HBuilderXBrackets

文本编辑器选择:Notepad++

必备开发插件:Emmet

硬核编辑器推荐:txt编辑器

为何不推荐Dreamweaver

原因很简单,“难用”。

如果你有幸进入或者任职于任何一家互联网公司,你会发现根本没有人用它做大型项目开发。

它臃肿、庞大、无用功能极多、编辑不方便、调整代码速度缓慢、不好看……这是我能列举出来最基本的几个理由,另外一个则是为了大家的未来考虑。

手写HTML代码可以有效的培养自己对DOM结构的理解,直接上手写项目是最快的学习方法。

设计稿审阅工具

喜大普奔!由于大家的热情支持,现在百科的大部分模版UI都会经过黑盒设计师小姐姐的手,为了保证模版的还原度,东哥我这边会和小姐姐沟通索要Sketch文件。

《Sketch》是在Mac OSX平台上使用的专业版UI设计软件,这个软件只能在Mac上使用,但Windows上也有可以打开Sketch文件的软件,所以请大家使用下面两个软件来检查设计稿。

osx:Sketch

Win:Lunacy

百科相关规范

命名规范

发起新的游戏模板开发时,请用下面的方式来声明大家必须要阅读的规则:

  • 新建一个空的模板,并命名为README
  • 在空的模板中,直接写出你想要大家遵守的开发规则。

单个模板内统一英文英文缩写或者统一拼音命名,并在命名时统一使用连字符命名原则下划线原则或者camalCase命名原则

使用拼音时,注意命名的概念应当清晰,例如:

shou_wang_xian_feng_hei_he_bai_ke

而不是:

pi_gu_bai_ke

视频、图片上传时

如果有需要注明图片与dpi,可以在文件名部分加上@来指明:

ve-ui-yi-ge-wf-jm@2x.png

this-could-be-a-file@350px.jpg

在标记时通常只需要注明图片的宽度即可。

请不要在文件名中使用/*()[]{}.><?\|、 等开发常用的半角字符以及经常引发bug的半角字符。

在命名时,最好将图片的标签用连字符的方式写入,以便于我们在后台查找数据,例如:

mp-weapon-rifle-rspn101@2x.png

数据表中

在设计模板数据节点时,请使用自然语言——英语或者拼音,千万不要使用过于随意单词或者字母!!,例如:

{{ skill_desc_0 }}

{{ shu_ju_miao_shu_0 }}

另外,任一百科中第一栏——id下方的内容必须唯一,否则会出现冲突,系统会自动清除重复id对应其中之一行的所有内容。

一般可以采用修改后缀、前缀、插入等方式修改,例如:

  • 枪械数据表格下ID:平行步枪
  • 武器皮肤表格下ID:平行步枪_
  • 武器配件表格下ID:平行步枪@

以此来在不同模版中调用不同的内容,建议在构建数据表时与他人商议清楚,在表格名字中进行标注。

HTML页面内

HTML(class、id、name)JavaScript部分,也请使用统一的命名原则,例如:

class=“skillDesc”

var skillDesc = new function();

在调用模板数据节点的位置,也就是{{ node }}的时候,还请使用统一的命名原则,例如:

{{ skill_desc_0 }}

{{ shu_ju_miao_shu_0 }}

请不要使用如下可能会引起页面bug的class名(持续更新):

  • class=”list”
  • class=”container”
  • class=”article”
  • class=”article-content”
  • class=”tag”
  • class=”title”
  • class=”editor”

如果你想要在模版中套用黑盒的样式设计,你可以自行启动浏览器的开发者工具查看相关css代码。除非必要,否则请一定不要使用!important覆盖原有的样式设计。

各部分的注释代码

各位写代码的时候都有自己的风格,为了方便将来的检查维护,需要各位使用注释来标记出自己的编辑内容。

同时也需要用注释写明每一段内容的作用,以方便将来的合并和拉取。

代码块

HTML

<--! 头图信息展示#完成 @东云闲 --------------------------------- -->

这里是一段html代码

JavaScript

// 头图轮播控制#未完成 @东云闲 //

——————————-

这是一段JavaScript代码 //这里是这一行代码的功能

这是另一段JavaScript代码

CSS

/* 起点:头图轮播样式#完成 @东云闲

————————————- */

/* 头图banner样式 */

这是一段css代码

这是另一段css代码

如果你想要为其他人撰写的代码进行调整,请在群内联系对应的代码负责人之后修改。

修改时请将源代码进行注释操作,另起一行撰写你的新代码,并写上方便阅读的注释。

负责人需要在收到联系信息之后,登录后台查看对方做的修改,并想办法将之合并到自己的代码中,或者删除对方的代码并联系对方。

如果有人想要负责整个模板的开发,可以直接在开头使用4~5行注释来声明,例如:

如果出现多人同时进行一个模板的开发,请保持好即时的聊天反馈。

其中一人更新代码时,其他人请勿在页面上操作或者提交自己的代码。

当代码更新完毕后,请阅读过更新后的代码再进行合并和插入。

总而言之

希望大家在编写百科的时候尽量遵守以上规范,以便日后更多热爱编辑百科的玩家加入进大行列。

每个百科之间的需求文档暂且不做规范,个人可以自行制作使用。

期望大家做的愉快,希望百科里可以增加Markdown格式用来让大家做笔记~

分享到:

评论已关闭