为啥要搞清楚编码规范的文档结构在公司做开发,最怕遇到那种没人维护、注释乱写、命名随心所欲的代码。新来的同事打开文件一看,满屏 var a = {}; function b() ...
下面是标题中包含该 TAG 关键词的相关文章列表,采用字母图标与卡片式布局展示。
为啥要搞清楚编码规范的文档结构在公司做开发,最怕遇到那种没人维护、注释乱写、命名随心所欲的代码。新来的同事打开文件一看,满屏 var a = {}; function b() ...
很多人写技术文档,尤其是编码规范,容易堆砌规则,结果文档越写越厚,但开发看了还是不知道怎么用。问题往往不在规则本身,而在结构没搭好。 从实际场景出发设计结构 想...
写文档时,很多人一上来就埋头输入内容,结果写着写着发现逻辑混乱,章节之间不连贯,回头修改又费时费力。其实,就像盖房子要先搭骨架一样,文档也得有个清晰的框架结构。 什么是文档的框...