育才学习网程序员开发手册怎么写(码出高效java开发手册,这本书怎么样)
1.码出高效 java开发手册,这本书怎么样
《码出高效：Java开发手册》
引爆技术圈，全球瞩目的中国计算机民族图书，中国人自己原创的Java编程规范，希望未来社会发展的每一行代码都规范、合理、高效！马云、行癫、鲁肃亲笔推荐！
《码出高效：Java 开发手册》源于影响了全球250万名开发工程师的《阿里巴巴Java开发手册》，作者静心沉淀，对Java规约的来龙去脉进行了全面而彻底的内容梳理。《码出高效：Java 开发手册》以实战为中心，以新颖的角度全面阐述面向对象理论，逐步深入地探索怎样成为一位优秀开发工程师。比如：如何驾轻就熟地使用各类集合框架；如何得心应手地处理高并发多线程问题；如何顺其自然地写出可读性强、可维护性好的优雅代码。
《码出高效：Java 开发手册》旁征博引、文风轻松，秉持“图胜于表，表胜于言”的理念，深入浅出地将计算机基础、面向对象思想、JVM探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的目标，结合阿里巴巴实践经验和故障案例，与底层源码解析融会贯通，娓娓道来。
《码出高效：Java 开发手册》以打造民族标杆图书为己任，追求极致，打磨精品，在技术广度和深度上兼具极强的参考性，适合计算机相关行业的管理者和研发人员、高等院校的计算机专业师生等阅读。无论是初学者入门，或是中、高级程序员的进阶提升，《码出高效：Java 开发手册》均为不容置疑的选择。
2.如何写详细设计文档
在大多数软件项目中，要末不作详细设计，要么开发完成后再补详细设计文档，质量也不容乐观，文档与系统往往不能同步，使详细设计文档完全流于形式，对工作没有起到实际的帮助。
·
详细设计是相对概要设计而言的，是瀑布开发流程的一个重要环节，在概要设计的高层设计的基础上，从逻辑上实现了每一模块的功能，是编码阶段的主要参考资料，是从高层到低层、逐步精化思想的具体实现。
详细设计文档的内容包括各个模块的算法设计，
接口设计，
数据结构设计，交互设计等。必须写清楚各个模块/接口/公共对象的定义，列明各个模块程序的
各种执行条件与期望的运行效果，还要正确处理各种可能的异常。
·
在开发过程中，由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素，而软件系统的一个重要特性就是需求和设计的不断构建和改进，在写详细设计文档过程中，
详细设计实际上是对系统的一次逻辑构建，可以有效验证需求的完整性及正确性。
如果不写详细设计文档，一般就从概设直接进入编码阶段，这时开发人员所能参考的资料就是需求规格说明书及页面原型、数据库设计等，不能直接进行开发，需要进行信息的沟通，把页面原型不能体现的设计讲清楚，这样既容易遗忘，也容易发生问题，详细设计文档可以作为需求人员、总体设计人员与开发人员的沟通工具，把静态页面无法体现的设计体现出来，包含整体设计对模块设计的规范，体现对设计上的一些决策，例如选用的算法，对一些关键问题的设计考虑等等，使开发人员能快速进入开发，提高沟通效率，减少沟通问题。
对于系统功能的调整，后期的维护，详设文档提供了模块设计上的考虑、决策，包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实现设计等等信息，提供了对模块设计的概述性信息，阐明了模块设计上的决策，配合代码注释，可以相对轻松读懂原有设计。
·存在的问题要由专门的人写，是比较麻烦的，也是很需要时间的，会对进度造成压力，也容易形成工作瓶颈，使设计人员负担过重，而开发人员无事可作。对于现在一般的以数据库为中心的管理系统而言，这个工作始终是要作的，区别只不过是不是形成专门文档，形成文档可能会多花一两周时间，但相对于规避的风险和问题来说，也是值得的，另外由于现在高级语言的流行，所以更详细的设计应该直接体现在代码的设计上，而文档则只体现设计上的一些决策，协调整体设计与模块设计的关系，把页面原型所不能体现的设计情况文档化，所以所花费的时间是有限的。
设计内容容易过细，但设计阶段是不能考虑特别清楚地，时间也不允许。
对于这个问题，一个对策是上边所提到的，文档只体现设计上的决策，页面原型所不能反映的信息，详细设计只体现总体设计对模块设计的一些考虑，例如对功能的数据库设计等等，而具体的实现实现，则到代码中再去实现，相关的设计也仅体现在代码中。
需求、设计需要不断的被更新、构建，则设计文档需要不断的重新调整，文档的维护需要跟上，否则文档和系统的同步就很难得到保障了，且造成多余的工作量。文档的内容易流于形势，质量糟糕，不能成为开发人员的参考手册，一是要建立起相关制度，如有修改，先改文档，后作开发，从工作流程上切实保障文档与系统的同步，二是要规范文档质量，对文档该写什么，不该写什么，标准是什么，粒度是什么，语法应该如何组织，有明确的标准和考虑，同时，建立审计文档评审、审核制度，充分保障系统的使用。·
首先是文档的内容，根据项目和团队的不同，详细设计文档的内容也有所不同，一般说来，粒度不宜过细，不能代替开发人员的设计和思考，但要把有关设计的决策考虑进去，包括与其他模块、整体设计的关系、操作的处理流程，对业务规则的设计考虑等，有一个标准为，凡是页面原型、需求规格说明书所不能反映的设计决策，而开发人员又需要了解的，都要写入文档。
其次是文档所面向的读者，主要为模块开发人员、后期维护人员，模块开发人员通过详细设计文档和页面原型来了解所开发的功能，后期维护人员通过实际系统、模块代码、详细设计文档来了解一个功能。
再有就是谁来写文档，因为文档主要考虑的是设计上的决策，所以写文档的人应该为负责、参加设计的技术经理、资深程序员，根据团队情况和项目规模、复杂度的不同，也有所不同。
还需要保证文档的可读性、准确性、一致性，要建立严格的文档模板及标准，保证文档的可读性及准确性，同时建立审核及设计评审制度，来保障设计及文档的质量，另外在工作流程中要强调，要先设计、先写文档，再进行开发。
3.如何编写帮助文档
每个开发人员都知道改写原有的应用程序是一项多么艰苦的事情。
对先前开发小组思维模式进行逆向工程是对开发人员技术水平的真正测试。真正阻碍这一过程的一件事是没有相关文档可用，而且同时（原有）应用程序所涉及的开发人员全部不在。
所以，既然开发人员知道即使最基本的文档都能够成为很有用的工具，那么为什么我们常常会忽视这一项工作呢？我所认识的大多数开发人员都承认他们没有足够的时间来编写文档。但是，这项平凡的工作确实能够为你或者你的同事节省大量的开发时间。
如果你需要编写文档，那就看看本文的提示吧，你会知道帮助文档需要包含哪些内容，以及在哪些地方可以找到帮助完成这一任务的工具。描述应用程序的核心元素从一开始就概括应用程序的技术细节当然是非常的理想的。
简化这一过程的一种方式是首先抓住每个应用程序都有的四个核心元素：数据、业务规则、用户界面，以及安全。下面我就详细解释一下每个部分：数据：系统所使用的后端数据既可以简单到只有几个表格，也可以复杂到有数百个表格，甚至是存储过程、视图和其他等等。
当开发人员面对新的系统时，手里有最新的数据模型/图表就能够为他们节省大量的时间。 业务规则：目前，进行系统设计的方法是把业务规则放在设计人员自己（开发）的对象里，同数据和用户界面隔离开，但是这未必就是正确的。
一个概述系统业务规则的简单文档能够在很大程度上增强读者对应用程序的用途的理解。 用户界面：我认为用户界面是比较容易理解的应用程序特性之一，这主要是因为通过启动和使用应用程序你就可以对它有一个比较好的感受。
由于常常会使用自定义控件或者第三方的工具，所以理解起来会稍稍困难一些。为用户界面编写文档的一个好方法是提供系统所用的窗体和其它元素的列表及其详细说明。
安全：开发人员在给系统编写帮助文档的时候常常会忽视安全这一特性。当你查看原有代码的时候，你毫无疑问将注意到不同地方都设置了安全检查，但是要对应用程序的安全模型有一个整体上的认识是很困难的。
4.java面试官问有没有写过文档（面试java程序员）,我想知道写文档是
我想他的文档是指在项目开发过程中 不同阶段的文档
我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ，操作手册 （这个也算）
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的。文档编写时间 主要是代码开发前 与 转测试后
5.求VC6.0开发手册中文版
中国IT实验室 很多计算机相关书籍 喜欢的朋友可以去瞧瞧；（不过顶一下再走，呵呵）给出部分书的名称：精通Visual C++图像编程 MFC中文帮助 MFC程序员的WTL指南 VC6从入门到精通-开发者眼中的VC VC6从入门到精通-附录 MS VC++6.0程序员指南 VC6从入门到精通-基础篇 VC6从入门到精通-VC与INTERNET Visual C++ 使用指南 Visual C++知识库 Visual C++ MFC入门教程 Visual C++ 6 参考大全 跟我学 VISUAL C++ 6.0 Visual C++ 6.0语言参考手册 Visual Lisp开发人员手册 Visual C++ 从入门到精通 Visual J++ 6.0 WFC 类库手册 Visual InterDev 从入门到精通 Visual C++ 6.0用户开发手册 VC编程指南 VC++6.0 类库参考手册 VC++database编程大全 VC6.0 运行库参考手册 Visual C++6.0运行库参考手册 VC++6.0模板库手册 VC++面向对象入门 VC新手学堂 Visual C++ 6.0预处理器参考手册 VC5.0开发人员参考手册 VC6中文版程序员开发指南 Visual J++ 6.0 WFC类库参考手册一 VC6 模板库参考手册 VC++编程指南 Visual J++ 6.0 WFC类库参考手册二 VC6.0 MFC类库参考手册 VC6从入门到精通-VC与数据库管理 MS VC++ 6.0 MFC类库参考手册 一 MS VC++ 6.0 MFC类库参考手册 二 走进Visual C++ 实例篇 Visual C++ 实践与提高-图形图像编程篇 Visual C++ 数字图像处理 VC-MFC编程实例 Visual C++实践与提高_环境剖析IDE篇 Visual C++程序设计：基础与实例分析 Visual C++ 6.0实例 Visual C++课程设计案例精编 Visual C++ 6.0开发与实例 VISUAL C++扩展编程实例 Visual C++6.0高级编程技巧与实例 VC++扩展编程实例 Visual C++编程技巧与范例 战胜Visual C++必做练习50题 Visual C++6.0编程与实例解析 VC-MFC扩展编程实例 MFC资源大全 精通Visual C++ 6.0 Visual C++程序模块集锦 Visual C++_Turbo C串口通信编程 Visual C++ 6.0应用编程150例 Visual C++ 6.0实例教程电子教案 教程篇 MFC Windows程序设计 Visual C++网络通信协议分析 VC6.0数据库编程 Visual C++ 学习教程 Visual_C++_新起点—6.0实用教程 Visual C++ 6-24学时学习教程 Visual C++ 6.0 21天自学教程 VC++网络教程 Visual C++ MFC 简明教程 VC 数据库编程三部教学 Visual C++ 6.0 数据库编程大全 VC新手学堂简明教程 Visual C++ 6.0 开发宝典 Visual C++ 6.0 教程 Visual C++ 6.0 高级编程 VC++6.0培训教程 Visual J++ 6.0 即学即用 Visual C++与面向对象程序设计教程 Visual C++6.0高级开发教程 Visual C++.NET 宝典 Visual C++5.0 程序设计 技术与应用 VC++6.0 用户界面制作技术与应用实例 深入浅出WINDOWS MFC程序设计 Visual C++ 角色扮演游戏程序 Visual C++6.0程序设计提高篇 VC++编程资料 VC++ 函数经典 VC++与Matlab混合编程的快速实现 Visual C++ 5.0易学活用 VISUAL C++ 设计WIN32应用程序 Visual C++入门与应用 Visual C++6.0开发宝典 Visual C++6.0技术内幕 VC++6编程方法 深入VC编程内幕 VC编程经验总结 用VC++编写USB接口通信程序 用VC开发CGI 疯狂VC技巧集 VC6开发宝典 Visual C++经典 Visual C++ 6 轻松进阶 VC编程常用捷径 MFC技术内幕 VC深入编程。
6.简历上的项目描述（JAVA）怎么写
想要成为合格的Java程序员或工程师到底需要具备哪些专业技能，面试者在面试之前到底需要准备哪些东西呢？本文陈列的这些内容既可以作为个人简历中的内容，也可以作为面试的时候跟面试官聊的东西，你可以把这些内容写到你的简历中，当然更需要的是你在面试的时候向面试官展示这些专业技能。
相信此文对正在寻觅Java程序员（Java工程师）职位的freshman以及希望成为中高级Java开发者的junior都会有所帮助。专业技能 1.熟练的使用Java语言进行面向对象程序设计，有良好的编程习惯，熟悉常用的Java API，包括集合框架、多线程（并发编程）、I/O(NIO)、Socket、JDBC、XML、反射等。
2.熟悉基于JSP和Servlet的Java Web开发，对Servlet和JSP的工作原理和生命周期有深入了解，熟练的使用JSTL和EL编写无脚本动态页面，有使用监听器、过滤器等Web组 件以及MVC架构模式进行Java Web项目开发的经验。 3.对Spring的IoC容器和AOP原理有深入了解，熟练的运用Spring框架管理各种Web组件及其依赖关系，熟练的使用Spring进行事务、日志、安全性等的管理，有使用Spring MVC作为表示层技术以及使用Spring提供的持久化支持进行Web项目开发的经验，熟悉Spring对其他框架的整合。
4.熟练的使用Hibernate、MyBatis等ORM框架，熟悉Hibernate和MyBatis的核心API，对Hibernate的关联映射、继承映射、组件映射、缓存机制、事务管理以及性能调优等有深入的理解。 5.熟练的使用HTML、CSS和JavaScript进行Web前端开发，熟悉jQuery和Bootstrap，对Ajax技术在Web项目中的应用有深入理解，有使用前端MVC框架（AngularJS）和JavaScript模板引擎（HandleBars）进行项目开发的经验。
6.熟悉常用的关系型数据库产品（MySQL、Oracle），熟练的使用SQL和PL/SQL进行数据库编程。 7.熟悉面向对象的设计原则，对GoF设计模式和企业应用架构模式有深入的了解和实际开发的相关经验，熟练的使用UML进行面向对象的分析和设计，有TDD（测试驱动开发）和DDD（领域驱动设计）的经验。
8.熟悉Apache、NginX、Tomcat、WildFly、Weblogic等Web服务器和应用服务器的使用，熟悉多种服务器整合、集群和负载均衡的配置。 9.熟练的使用产品原型工具Axure，熟练的使用设计建模工具PowerDesigner和Enterprise Architect，熟练的使用Java开发环境Eclipse和IntelliJ，熟练的使用前端开发环境WebStorm，熟练的使用软件版本控制工具SVN和Git，熟练的使用项目构建和管理工具Maven和Gradle。
说明：上面罗列的这些东西并不是每一项你都要烂熟于心，根据企业招聘的具体要求可以做相应的有针对性的准备。我个人觉得前6项应该是最低要求，是作为一个Java开发者必须要具备的专业技能 项目介绍 本系统是X委托Y开发的用于Z的系统，系统包括A、B、C、D等模块。
系统使用了Java企业级开发的开源框架E以及前端技术F。表示层运用了G架构，使用H作为视图I作为控制器并实现了REST风格的请求；业务逻辑层运用了J模式，并通过K实现事务、日志和安全性等功能，通过L实现缓存服务；持久层使用了M封装CRUD操作，底层使用N实现数据存取。
整个项目采用了P开发模型。说明：上面的描述中，E通常指Spring(Java企业级开发的一站式选择)；F最有可能是jQuery库及其插件或者是Bootstrap框架，当然如果要构建单页应用（SPA）最佳的方案是前端MVC框架（如AngularJS）和JavaScript模板引擎（如HandleBars）;G显然是MVC（模型-视图-控制），最有可能的实现框架是Spring MVC，除此之外还有Struts 2、JSF以及Apache为JSF提供的MyFaces实现，可以使用JSP作为MVC中的V，也可使用模板引擎（如Freemarker和Velocity）来生成视图，还可以是各种文档或报表（如Excel和PDF等），而Servlet和自定义的控制器是MVC中的C，当然Spring MVC中提供了作为前端控制器的DispatcherServlet;J通常是事务脚本，K应该是AOP（面向切面编程）技术，L目前广泛使用的有memcached和Redis;M的选择方案很多，最有可能的是Hibernate和MyBatis，也可以两种技术同时运用，但通常是将增删改交给Hibernate来处理，而复杂的查询则由MyBatis完成，此外TopLink、jOOQ也是优秀的持久层解决方案；底层的数据存取传统上是使用关系型数据库，可以是MySQL、Oracle、SQLServer、DB2等，随着大数据时代的来临，也可以采用NoSQL（如MongoDB、MemBase、BigTable等）和其他大数据存取方案（如GFS、HDFS等）；项目的开发模型P可以是瀑布模型、快速原型模型、增量模型、螺旋模型、喷泉模型、RAD模型等。
项目开发流程1.可行性分析 >>> 可行性分析报告 / 项目开发计划书2.需求分析 >>> 需求规格说明书 1.OOAD（用例图、时序图、活动图） 2.界面原型：帮助理解需求、业务层设计时推导事务脚本3.设计 >>> 概要设计说明书/详细设计说明书 1.抽取业务实体（领域对象）：类图、E-R图（概念设计阶段） 2.分层架构：确定各层的技术实现方案（具体到使用的框架、数据库服务器、应用服务器等）。业务层设计：事务脚本模式。
php开发文档怎么写
1.PHP文件如何编辑
关于php文件怎么打开的问题，我想对于一名站长来说并不陌生，老站长们都明白，从一个菜鸟到老鸟的过程，PHP的学习和了解是必须的，如果你不懂什么是PHP，那么很难混下去。
1.PHP文件是一个文本文件，如果您在本地是无法用浏览器读取的，但是您可以使用Dreamweaver、Zend Studio 、eclipse或emeditor等软件打开和编辑，如果您还不知道如何编辑PHP，可以参照烈火网的PHP开发手册学习这个强大的WEB开发语言。2.PHP在成功开发以后，可以在PHP环境（您可以直接PHP安装包，然后参照IIS下PHP+mysql的安装教程来搭建PHP环境，亦可以直接使用PHP套件，例如：xampp、APMServ等软件）下浏览。
2.PHP文件如何编辑
关于php文件怎么打开的问题，我想对于一名站长来说并不陌生，老站长们都明白，从一个菜鸟到老鸟的过程，PHP的学习和了解是必须的，如果你不懂什么是PHP，那么很难混下去。
1.PHP文件是一个文本文件，如果您在本地是无法用浏览器读取的，但是您可以使用Dreamweaver、Zend Studio 、eclipse或emeditor等软件打开和编辑，如果您还不知道如何编辑PHP，可以参照烈火网的PHP开发手册学习这个强大的WEB开发语言。
2.PHP在成功开发以后，可以在PHP环境（您可以直接PHP安装包，然后参照IIS下PHP+mysql的安装教程来搭建PHP环境，亦可以直接使用PHP套件，例如：xampp、APMServ等软件）下浏览。
3.php怎样写开发方案
1. site's goals
2 functionality - you could use the mind maps to brainstorm features of the site
3. unit testing ( option)
4 UI design
4 coding
4.1 planning
4.2 database design
4.3 coding
5 Report
4.PHP怎么写入TXT文档
$arr=mysql_query("select * from test order by id desc");
while($rs=mysql_fetch_array($arr)){
$str ="ID:".$rs["id"]."\r\n"."名称：".$rs["name"]."\r\n";
$k=fopen("1.txt","a+")；//此处用a+，读写方式打开，将文件指针指向文件末尾。如果文件不存在则尝试创建之
fwrite($k,$str);
fclose($k);
}
你上面的$str被不停地替换，所以每次都是取最后一组数据
或者你改为$str =$str."ID:".$rs["id"]."\r\n"."名称：".$rs["name"]."\r\n";
5.php网站开发文档需要数据流程图吗
不需要，一般开发文档的写两个就可以了，设计文档，技术文档，里面想应
都是设计需求，页面标示，数据库描述，页面逻辑等等，当然，不排除有时
根据客户需要加如其他辅助文档
设计文档：要有设计需求，可伸缩式的把握语言，图片的描述；
技术文档：整个项目开发完毕以后的一个总结，包括目录结构，
每一个页面相应的功能描述，数据库描述，页面逻辑；
所谓的页面逻辑，就是操作页面的具体流程，同样也是伸缩式
的去描述，当然重点操作部分要详细描述；
这些文档都是为了方便使用者或者后期维护人员看的，只要你认
为对他们有意的内容，都可以适当添加，毕竟文档是死的，人是
活的，有用的才是精贵的~
api开发文档怎么写
1.如何优雅的“编写”api接口文档
1） 编写不方便。每次新增借口的时候都要复制上一个接口，然后再进行修改，一些相同的部分无法复用，接口多了文档会变的很长，还经常需要调整格式。2） 发布不方便。文档更新时，需要发给需要的小伙伴。即使用Git来进行管理，虽然拉取比较方便，但由于文件格式的问题，也不方便比较两次提交的差异。
由于有这些问题，决定寻找一种更优雅有效的方式来编写文档。经过比较，发现了apidoc，可以比较好的解决上面提到的问题。apidoc采用了一种类似写代码注释的方式来写文档，支持编写多种语言的文档。最后生成的文档以网页的形式发布，方便快捷，便于阅读。下面就来简单介绍一下怎么使用apidoc来写文档。
1.安装node
由于apidoc依赖Node.js的包管理工具npm进行安装，所以安装apidoc之前要先安装node.js(npm会在安装node时顺带进行安装)。具体的安装教程可以参考这里。
2.安装apidoc
安装完了npm之后，就可以安装apidoc了。在命令行输入
2.java api接口文档编写
Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。
自行搜索一下javadoc即可，示例如下：
/**
* 类描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 内部属性：name
*/
private String name;
/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}
3.如何快速编写api文档
这里所用到的工具就是javadoc2chm.百度”javadoc2chm“下载。
我看到有一个1积分下载的，我这里也有，需要的话可以私聊。2javadoc2chm.exe的大小只有102k左右，谨防上当受骗啊。
3使用javadoc2chm制作帮助文档的时候，首先下载的文件中有帮助文档的html版。例如我下载的Struts2就有doc目录。
4打开javadoc2chm.exe. path to javadoc是用来选择doc的路径的，output filename是用来给输出的chm一个名字，以.chm结尾，title是打开chm后首页的文字5我这里以制作Hadoop2.7.1的帮助文档实例。选好目录后，点击Go就开始只做了，制作完成后，go按键变黑色可用，只做好的chm文档存放在你选择的html帮助文档的目录里。
END注意事项注意output filename是用来给输出的chm一个名字，以.chm结尾如果不是，输出后改一下工作愉快！点赞啊。
4.什么是接口文档,如何写接口,有什么规范
首先要有一个文档的标题，XXX接口文档，符合当前文档的说明，文档的生产日期，以及公司名称等。现在开始写一个dubbo接口文档，定义标题，以及日期，这里公司省略。使用confluence在线编辑，Confluence为团队提供一个协作环境。团队成员协同地编写文档和管理项目。从此打破不同团队、不同部门以及个人之间信息孤岛的僵局，Confluence实现了资源的共享。
接下来要有当前文档的版本修订信息，即为历史修订信息，应当包含基础的信息有：版本号、修订日期、修订人、修订说明等。
开始编写文档的目录结构，注意大标题和小标题的使用，需要合理的运用说明。首先当然是文档的说明信息，再来是一些准备信息和流程信息，然后开始接口说明，最后可以有举例、常见问题、注意事项、响应码的说明信息等等。
下面开始按照文档的目录结构逐一进行详细的介绍说明，比如文档说明的介绍，用高效简洁的语言明确的说明文档信息，注意文档中大标题应当字体大小样式一致，小标题也应当字体大小注意保持一致。
简单的说明技术资料获取及准备，确认调用系统信息比较重要，需要确认编码格式，防止乱码，确认当前的文档版本是否是要使用的版本，否则白做无用功，项目的搭建环境简单说明即可。
开始说明接口的调用流程，如何调用接口，需要做的一些准备，说明引入相应的依赖以及配置需要配置的文件。
现在可以开始接口的说明，接口的说明信息应当包含接口的名称，接口的地址，接口的协议，然后针对当前接口下的方法说明。
方法的说明应当包含方法的描述，即其作用，方法的请求参数说明，以及响应的参数说明，参数说明应当包含参数的类型，参数名称，参数的含义，并且备注参数是否必须传递。
9
接口说明完之后，就是文档的末尾，有注意事项添加一些注意事项，或者附录说明，添加标注。
5.什么是API文档
【2006-02-08 13:54】【】【SUN】 Sun 公司提供的Java API Docs是学习和使用Java语言中最经常使用的参考资料之一。但是长期以来此文档只有英文版，对于中国地区的Java开发者来说相当的不便。目前Sun 公司正在组织多方力量将此文档翻译成中文，并于近日在Sun 中国技术社区（.cn/）正式发布java.lang和java.util类库API 文档的中文版，其他类库API文档的中文版也将于今后一段时间内陆续向中国地区的开发人员提供。在J2SE API文档（5.0版本）的汉化工作完成之后，Sun 中国技术社区还将开通Java API 文档中文版的打包下载服务。
Java API 文档中文版发布计划
发布时间 相关类库 阅读/下载
2005/10/31 java.lang
java.util 在线阅读
2005/12/31 java.awt
java.io
java.text 在线阅读
2006/02/28 javax.swing 在线阅读
2006/03/31 java.applet
java.beans
java.maths
java.net
java.nio
java.rmi
java.security
java.sql
javax.accessibility
javax.activity
javax.crypto
2006/04/30 javax.imageio
javax.management
javax.net
javax.naming
javax.print
javax.rmi
javax.security
javax.sound
2006/05/31 javax.sql
javax.transaction
javax.xml
org.ietf
org.xml
org.w3c
org.omg
原文地址：.cn/chinese_java
java的开发文档怎么写
1. 如何书写Java项目的开发文档
我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。
人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。
2. 如何书写Java项目的开发文档
我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。
人员流动是项目进行中比较让人头疼的事情。
做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。
比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。
3. java编写的记事本开发文档如何写我们用Java编写了一个记事本 爱问知
class Pop_undo_actionAdapter implements Java。
awt。event。
ActionListener{ Jsb adaptee; Pop_undo_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。
pop_undo_actionPerformed(e); } } class Pop_cut_actionAdapter implements java。 awt。
event。ActionListener{ Jsb adaptee; Pop_cut_actionAdapter(Jsb adaptee){ this。
adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_cut_actionPerformed(e); } } class Pop_copy_actionAdapter implements java。
awt。event。
ActionListener{ Jsb adaptee; Pop_copy_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。
pop_copy_acionPerformed(e); } } class Pop_paste_actionAdapter implements java。 awt。
event。ActionListener{ Jsb adaptee; Pop_paste_actionAdapter(Jsb adaptee){ this。
adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_paste_actionPerformed(e); } } class Pop_delete_actionAdapter implements java。
awt。event。
ActionListener{ Jsb adaptee; Pop_delete_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。
pop_delete_actionPerformed(e); } } /******************* Event class end **********************************/ /************************************************************* * title: DlgText。 java * author: jeason * date: 2004-12-21 **************************************************************/ package jeason; import java。
awt。*; import java。
awt。event。
*; import javax。swing。
*; public class Dlgtext extends JDialog{ private boolean check=false; JLabel text=new JLabel( ); JButton BTnOk=new JButton( ); JButton btnNo=new JButton( ); FlowLayout flowLayout1=new FlowLayout(); Dlgtext(){ this(null,"",false); } Dlgtext(Frame frame, String title, boolean modal){ super(frame,title,modal); text。 setText（" 你要保存吗？ "）； text。
setSize(200,60); this。setSize(200,80); this。
setModal(true); btnOk。setText（"确定（Y）"); btnOk。
setMnemonic（´Y´）；。
4. java 项目需求文档要怎么写
需求文档一般分两类
需求调研报告
需求分析报告
调研报告：是记录的用户的原始需求，基本上可以算做是和用户沟通的原始记录。
分析报告：是对调研报告进行归类分析的结果。一个比较全面的文档了，在这个文档里面一般包含以下内容：
项目的背景
项目的目标
项目的范围
用户特点
相关技术、规范标准等
相关约束
用户的组织结构、角色等
用户需要的功能点，这些功能的优先级，业务流程、功能特点，有没有特殊需求等等
总而言之，需求分析报告的下一站是给设计人员的，设计人员看到需求分析报告就知道系统应该包含哪些功能点、权限设计、流程设计等，这些内容都可以直接从需要分析报告里面得出
5. java面试官问有没有写过文档（面试java程序员）,我想知道写文档是
我想他的文档是指在项目开发过程中 不同阶段的文档
我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ，操作手册 （这个也算）
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的。文档编写时间 主要是代码开发前 与 转测试后
程序员文档怎么写
1. 为什么程序员不愿写文档
其中的原因很多，我自己归纳了几点：1.怕烦程序员从入门之日起，就在心里埋藏了一颗编程的种子，认为程序员就是编程序的，就是和计算机打交道的，程序就是程序员的全部。
无论是在编程之前写文档，还是在编程之后写文档。他们都认为写文档很烦人。
1）文档种类太多。越正规越多。
一想到要写那么多的文档，程序员的头都要大了。2）文档写作要求不低。
有格式要求、内容要求，还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明，以及要收集各种资料。虽然没有技术含量，但是要花的时间比编程序多，而且也不一定能写好。
3）在正规的开发公司中一般一个变更就要编写一系列的变更文档。当不断变更时，只有最后的变更文档是最重要的。
当我们不知道当前是不是最后一个文档时，我们就不愿意写可能被后面的文档替代的文档。4）当写了文档之后，就会不断有使用文档的人来询问细节，这些询问往往会让人崩溃。
这是因为很难写出让每个人都提不出问题的文档。2.没空在很多情况下，程序员都处于一种“时间紧、任务重”状态。
在急于得出编程结果的驱使下，程序员一心扑在编程上，恨不得一分钟一个变化，哪有心思和时间先把文档写好再去编程呢？即使他们拥有先把程序编出来，然后再补写文档的想法，但是一旦他们完成一段程序之后，就会立即扑向第二段程序。如此下来，编写文档只能放在项目开发的后期了。
你要是真的写文档，那写文档的时间早已将编程时间给挤占了，你的编程工作就完不成了。3.没有用文档的重要性其实对不同对象是不一样的。
如果你说文档没有用，立即会有人用唾沫把你淹死，他们立即会搬出哪个哪个说文档是重要的，文档是不可缺的。唯独不敢说“我自己认为文档是重要的”。
这也反过来说明文档的有用性程度对不同人是不一样的。对于程序员来说，只要能把程序编出来就行了。
很多程序员不写文档照样编出程序来，在他们的观念中文档不写也罢。如果按文档编程序，那就要确保文档的正确性、不可更改性。
而实际上，文档不如编程快，编程不如变化快，不断变化的需求和代码让文档如同一张过时的废纸一样。在现实中，有的文档变成了项目开发后的总结，对开发本身并不起作用，只是保留一个存在的形式，以应付各种各样规范的需要。
在这种情况下，文档没有任何实用价值，所以即使程序员写了，也没有什么作用。尤其是项目投产后，几经升级，最初的文档早已和现实的情况对不上号了，文档更新和系统的一致性更是难于控制。
4.没好处既然认为编程序才是正道，那么程序员写文档就是一种额外和辅助的工作，做了就做了，对于程序员来说没有任何好处。当然，文档的好处更多地体现在软件公司、单位、软件用户、后续程序员身上，它是一种“前人栽树，后人乘凉”的好事。
所以程序员不愿意写文档。文档有多么重要呢？有人把它上升到“程序员头脑的拷贝”的高度，有的人甚至说，程序员走了后，只要有了文档，软件公司可以再招新人，公司照样运转起来。
如此说来，天性聪明的程序员会把文档写得清清楚楚吗？5.不会写从写作本身来看，写好一篇文档不是一件容易的事。文档有文档的格式和写作要求。
现在的人只喜欢动嘴说事，没有多少人在平时会动笔写字，更不用说写文章了。所以，写文档从理论上来说也是需要学习和训练的，需要在平时进行写作积累。
当要求一些程序员写文档的时候，他往往会回答你：“怎么写呀？我不会。”你不会写可以不怪你，你不去学，反而理直气壮地说不会，则是你的不对了。
难道那些会写文档的人都是“呆子”吗？难道他们不懂干活辛苦的道理吗？当一个男子向一个自己喜欢的女子示爱，需要用情书来表白的时候，难道他不会写情书吗？即使他不会写，他也一定会克服千难万险把情书写出来的，这是他的主观使然。如果程序员主观上想写文档，怎么会怕烦？怎么会怕没空？怎么会怕文档没有用？怎么会怕不会写？这些怕其实都是借口。
真正优秀的程序员应该不单是编程的高手，同时也应该是写文档的高手。程序员真正不喜欢写文档的原因是：文档是给别人看的，不是给自己看的。
如果要使程序员喜欢写文档，那就要提高程序员的意识和境界，或者要给写文档的程序员以奖励。而靠制度、管理让程序员去写文档只能是一种职业上的弊端。
当有一天写文档也成为一个专业化的岗位，程序员和文档人员分开时，程序员就会一心一意看文档写代码，文档员就会以此为职业，一心一意写文档拿工资。我们将不再为此进行讨论。
这种分工一定是未来的趋势。一些大的公司或管理规范的公司都已经有这样的分工了。
只是很多中小软件公司或企事业单位里的IT部门还没有专业化到如此程度。程序员不喜欢写文档也许说明他们不愿意承担太多的角色吧。
不管怎么说，作为一个程序员（尤其想成为优秀程序员）一定要学会写文档，一定要学会欣赏文档。无论你是否喜欢，你都应该可以在文档的各种问题面前可进可退。
可以这样说，那些既不会写文档，又不会欣赏文档的程序员是没有资格说“我就不喜欢写文档”这种话的。
2. java面试官问有没有写过文档（面试java程序员）,我想知道写文档是
我想他的文档是指在项目开发过程中 不同阶段的文档
我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ，操作手册 （这个也算）
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的。文档编写时间 主要是代码开发前 与 转测试后
3. java程序员需要些什么文档
我很少写文档，懒得写，除非项目有要求
对于文档这个东西简单谈一下
1. 做项目之前就有文档
这个是可遇不可求的，现在做的项目很多都是临时突然说要做的，什么需求都没有，只能靠程序员自己去发现，项目经理的要求，客户的临时需求（这个比较痛苦，他们有时候根本就不知道要什么，所以必须写好文档，跟客户谈好，不然又要变的时候，你就痛苦了）
如果项目一开始就有文档，当然也可能是你自己写的，也可能是其他人写好的，有些公司有人专门负责写，需求分档，项目分析文档，项目结构文档，数据库文档等等，不过之后可能需要你写测试文档，这个就没有听说过谁帮你做了，但是更多的情况也是不用写，就几个功能，自己和测试人员测测就算了，也有可能需要写使用文档，这个看情况了
2. 做项目之前没有文档
如果项目紧张，根本就不会写任何文档，但是当项目结束的时候，你又没有项目做，项目精灵可能就让你写写文档打发打发时间，
文档对于公司来说是很重要的，但是对于个人的话，就要看情况，如果你做了很多项目，其实什么文档也不需要，你大体上都知道这个项目就做什么用的，怎么架构的，那些代码是什么意思（你的编程习惯很好的情况下），所以很多公司都会要求程序员写文档，不然你走的时候，别的人怎么接受，让别人理解你的思想是很痛苦的，每个人的思想都是不一样的
4. 我是个编程的自学者,想当程序员不知道公司写文档是什么意思知道
以鄙人在软件公司工作的经验与你分享一下吧。
我们平时做项目，一般有一半以上时间都在管理文档，包括基本设计书，详细设计书，静态样式书，各种UML建模图，单体测试书，系统测试数，结合测试书，DB设计书，DB脚本，以及各种工具类管理文档，如资源文件管理，VBA管理等等，这还不包括项目前期的需求建设书，项目中期与客户交流的反馈书，项目后期的BUG管理书，以及贯穿项目的工程进度表和版本控制书。当然你的代码资源（包括注释，图片，脚本等）也属于文档，需要统一管理。
对于追求简短快的团队，未必会太重视文档的组织与管理，但是一定要相信文档看似浪费时间，其实无形中提高了很大的效率，而且在未来的开发提供了宝贵的参考资料。属于团队积累的一种。
5. 怎样写好软件文档
正文如下：
我不知道是不是有人会将阅读或书写技术文档当**好。虽然很讨厌这样做，但是通常为了解决问题或介绍一个技术产品，我们不得不去做这些事情。要想写好文档很难。技术文档有几种形式：基本概览，高级概览，一步一步的演示，自动生成的文档，等等。考虑下不同用户对你的文档的需求情况：不同的需求，不同的技术，不同的学习风格。你将会发现，没有一种格式能同时适应所有人。受众情况在写项目文档的时候，你首先要考虑到的是读者。最终用户首先需要的是一份入门指南。尽管一些技术概念可能会提到，但是重点应放在用户界面，而不是后台。如果是程序员，他可能会想得到更多的信息：程序运行原理，代码的实现，怎样对代码进行扩展，等等。为部分用户写的文档不应当影响到另一部分用户的阅读，你可以考虑写两份单独的文档，用户使用手册和技术文档。几种不同类型的文档 Jacob Kaplan-Moss在他的怎样写好文档的指南中，他提到了三种文档：教程，专题指南和参考指南。
教程：教程是很重要的，因为这往往是用户在使用新的工具时得到的第一印象。我们之前写到过，有许多不同的工具可以帮你写好教程。如果你想写的话，Kaplan-Moss建议你写得简单快速一些，但是不要太简单了，可以做一个演示，为每一步骤添加相关的截图。专题指南：Kaplan-Moss说这是文档的主要内容。虽然教程提供了一个高层次的概念，但是专题指南可以让感兴趣的人深入学习，内容一定要详尽。Kaplan-Moss提到，一般来说，图书要胜过官方文档，但是后者的一个优点是随时更新。参考指南：参考指南是为那些已经入门但是还需要更多信息的用户准备的。为那些已经知道怎样使用API，但是需要查找确切的函数参数或详细设置信息的用户定制的。要指出的是，参考指南是无法由教程和普通指南替代的。自动生成的文档只能起一个引导作用，如果没有额外的写作，编辑和组织，它是不可能解决大家的问题的。虽然这是“技术写作”，但是这并不意味着你应该放弃文采，语法和拼写检查。至少得检查一下语法和拼写吧。
转载请注明出处育才学习网 » 程序员开发文档怎么写