书写文档的一个注意事项

原创 2006年06月14日 00:23:00
在书写文档的时候,如果遇到图表,尤其是表示关系,(调用关系,依赖关系,数据流关系)的时候,一定要使用不同颜色/粗细/方向 的线条来表示不同的关系。
 
例如 数据通道,命令通道,异步消息通道,同步消息通道 等等,另外不同的模块之间也可以使用不同的颜色,以示区别。

JS 注意事项

1. 用 === 代替 == JavaScript里有两种不同的相等运算符:===|!== 和==|!=。相比之下,前者更值得推荐。请尽量使用前者。 引用: “如果两个比较对象有着同样的...
  • bestlxm
  • bestlxm
  • 2011年11月11日 16:56
  • 1769

API文档的写法

参考 格式 : API文档的写法 http://developer.baidu.com/wiki/index.php?title=%E5%B8%AE%E5%8A%A9%E6%96%87%E6%A...
  • guanhui077
  • guanhui077
  • 2013年04月03日 17:14
  • 830

CSS3代码编写规范及注意要点

CSS3编码规范及注意要点 语法: 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。为选择器分组时,将单独的选择器单独放在一行。为了代码的易读性,在每个声...
  • sinat_34719507
  • sinat_34719507
  • 2016年12月27日 01:43
  • 1823

书写安全Shell脚本的注意事项

【前言】 本文译自《Classic Shell Scripting》 UNIX的安全性一向是恶名在外,几乎从每个角度看,UNIX系统都有或多或少的安全性争议,不过这些大部分都是系统管理者应该担心...
  • Jerry_1126
  • Jerry_1126
  • 2016年08月26日 09:53
  • 875

编写头文件的注意事项

    我们在写头文件的时候,会用到其他类的头文件,有时候只需要用到其他类的声明,那么在什么情况下使用他们呢.    1.如果需要知道某个类的具体结构以及要使用这个类的某些接口,就要包含这个类的头文件...
  • peehk613
  • peehk613
  • 2008年01月24日 23:06
  • 366

工作中清晰明了的文档书写注意事项

1 为什么要做这件事, 2 目前做了哪些事 3(存在哪些问题)还有哪些事   每件事该由谁做。   每件事有1种或2~3种方案,每种方案优缺点列出,建议选择哪种方案。...
  • wolf_121
  • wolf_121
  • 2012年01月10日 09:44
  • 278

jquery注意事项(一)

1、有两个版本的 jQuery 可供下载: Production version - 用于实际的网站中,已被精简和压缩。  Development version - 用于测试和开发(未压缩,是可...
  • alert_Java_Song
  • alert_Java_Song
  • 2018年01月08日 16:22
  • 22

java代码编写注意事项

去掉程序中没用到的jar包,js文件等。 将css放在html页面的顶部,而把js放在html页面的底部 1.尽量指定类的final修饰符 带有final修饰符的类是不可派生的。在Java核心AP...
  • honey_Claire
  • honey_Claire
  • 2014年04月15日 10:40
  • 4275

软件开发文档分类以及和软件生命周期的关系

前一段时间写了初步学习了软件开发文档,虽然耗时不断感觉理解的并不是很深刻,最近我们举行了一次学术交流会,让我们重新认识了软件开发文档。一开始总感觉总是对文档不怎么感什么兴趣,枯燥、冗长、无聊,只是按照...
  • zjx86320
  • zjx86320
  • 2014年01月27日 20:47
  • 5259

python写程序注意事项(很重要)

  • xun527
  • xun527
  • 2017年07月18日 10:04
  • 197
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:书写文档的一个注意事项
举报原因:
原因补充:

(最多只允许输入30个字)