65,211
社区成员
发帖
与我相关
我的任务
分享请发表友善的回复…
发表回复
xhs_lh04 2009-01-22
- 打赏
- 举报
另外技术的文档都有相应的格式
你可以找个模板,按模板的纲要来组织内容,很简单
你可以找个模板,按模板的纲要来组织内容,很简单
xhs_lh04 2009-01-22
- 打赏
- 举报
注释跟文档,这个很好区分吧,我不想多说
不过两者之间是可以转换的
就是说桉规范写的注释可以通过工具生成文档(程序说明文档),C++/JAVA都有相应工具
不过两者之间是可以转换的
就是说桉规范写的注释可以通过工具生成文档(程序说明文档),C++/JAVA都有相应工具
ForestDB 2009-01-22
- 打赏
- 举报
文档可以看成规格说明书，系统设计书，详细设计书，测试计划及用例等一切非代码的书面的文字记录。
而注释从某种方面可以看成是代码的一部分，描述了代码的历史（谁在某年某月某日写了这个函数，做了什么更改），简单的算法逻辑描述，变量的作用的描述等等。
形式化或者格式化的描述可以用特定的工具提取出来，如javadoc或者NDoc，形成库说明帮助文档。
而注释从某种方面可以看成是代码的一部分，描述了代码的历史（谁在某年某月某日写了这个函数，做了什么更改），简单的算法逻辑描述，变量的作用的描述等等。
形式化或者格式化的描述可以用特定的工具提取出来，如javadoc或者NDoc，形成库说明帮助文档。
icesky_ff 2009-01-22
- 打赏
- 举报
文档是写在外边的系统性的说明，
注释是写在代码旁边对代码的详细解释
注释是写在代码旁边对代码的详细解释
nullah 2009-01-22
- 打赏
- 举报
文档：对整个项目的记录和注释
而注释是对源码中一些语句或者函数等的解释三
而注释是对源码中一些语句或者函数等的解释三
a695188837 2009-01-22
- 打赏
- 举报
谢谢各位！
waizqfor 2009-01-21
- 打赏
- 举报
文档:是对软件功能 和使用的说明书
注释：是对代码功能和结构的解释
简洁明了吧
注释：是对代码功能和结构的解释
简洁明了吧
星羽 2009-01-21
- 打赏
- 举报
。。。。。。。
最起码，注解主要是写在代码上的，比如
// 注解注解注解
int xxxx;
文档是单独的文件，有很多分类，比如 开发文档，需求文档，测试文档。。。。。
最起码，注解主要是写在代码上的，比如
// 注解注解注解
int xxxx;
文档是单独的文件，有很多分类，比如 开发文档，需求文档，测试文档。。。。。
xiaoyisnail 2009-01-21
- 打赏
- 举报
文档是一个软件项目过程中需要的一些书面计划，说明之类的东西
注释是代码中用来解释代码的文字说明
注释是代码中用来解释代码的文字说明
