请问代码说明文档怎么写？

LoveZhanHaiTao 2011-07-08 05:32:06

代码说明文档怎么写吗，哪位高手有模板，发来参考参考啦！谢谢！

...全文

1041 7 打赏收藏转发到动态举报

写回复

7 条回复

切换为时间正序

请发表友善的回复…

发表回复

LoveZhanHaiTao 2011-07-20

打赏
举报

回复

[Quote=引用 6 楼 ying312 的回复:]
把邮箱发过来，我给你发个，参考参考
[/Quote]
ying617463378@163.com谢谢

Ying312 2011-07-20

打赏
举报

回复

把邮箱发过来，我给你发个，参考参考

LoveZhanHaiTao 2011-07-13

打赏
举报

回复

就是没有找到我想要的《代码说明文档》我才到这里来咨询高手的嘛，要是我可以查到，那我就不需要到这里来发帖子啦！

避风港 2011-07-12

打赏
举报

回复

网上查查一大堆

lovetsfuer 2011-07-08

打赏
举报

回复

这个google很多吧

threenewbee 2011-07-08

打赏
举报

回复

http://www.google.com.hk/#hl=zh-CN&source=hp&q=%E4%BB%A3%E7%A0%81%E8%AF%B4%E6%98%8E%E6%96%87%E6%A1%A3&oq=%E4%BB%A3%E7%A0%81%E8%AF%B4%E6%98%8E%E6%96%87%E6%A1%A3&aq=f&aqi=&aql=&gs_sm=e&gs_upl=157l157l0l1l1l0l0l0l0l0l0ll0&fp=15565c0f28dd90de&biw=1192&bih=589

ICanSeeYou远程控制软件（所有C#源代码）另外附有说明文档。原程序（安装包）的下载地址：http://download1.csdn.net/down3/20070428/28022416404.rar源代码说明：IDE（集成开发环境）：Microsoft Visual Studio .NET 2005使用C#作为主要开发语言，统一编程习惯。关于C#编程习惯可以查看另外一份文档《 C#编程规范》。C#规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。代码重用性通过结合程序员定义的类和定义良好、精心测试、文档完整、可移植和用途广泛的FCL（重用框架类库），开发者进行软件构建，这种形式的软件重用加速了功能强大和高质量软件的开发。而本项目定义了不少可重用的代码，例如文件的各种操作，鼠标的模拟点击，键盘的模拟按键按下，关机，屏幕截取，API函数库，网络的基本操作等。

这是程序员讨论了很久的一个话题：要不要给代码写文档？值得给代码写文档吗？我曾经觉得这个话题实在是让人难以应付。也认为除去一些特殊的情况（比如编写公用 API），代码文档并不是那么必要。直到有一天，我在一份代码检查报告中发现，缺少文档被作为一项缺点指出来。真是这样的吗？我曾经也给我的代码写文档——至少我尝试了。我曾深信你必须给代码写文档。以后对我自己，或者对其他需要看

接口文档示例一、环境及版本说明 vue 版本 2.6.10 element-ui 版本 2.13.0 node版本12.14.1 二、开发相关环境及配置 2.1项目资料 2.1.1接口地址正式接口地址：https:// 测试接口地址:https:// 2.1.2文档地址接口文档:http:// 需求文档: 设计文档: 2.1.3 UI&UX地址原型图地址:http:// [负责人:] UI切图地址: [负责人:] 2.2项目配置 2.2.1安装node环境 2.2.2项目安装 npm

一、函数说明文档 1、函数说明文档简介 2、函数说明文档内容建议 2、代码示例 - 函数说明文档

叫你怎么写开发文档：步骤描述：步骤描述需要一定的逻辑性。但不一定是纯文字形式，可以用公式，便于理解的伪代码+文字等方式进行步骤描述

110,533

社区成员

642,574

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

让您成为最强悍的C#开发者

试试用AI创作助手写篇文章吧

+ 用AI写文章