以太坊java开发文档
1. 请高手指教,一个java WEB项目的开发文档要怎么写,让别的程序员一看就明白这个项目的框架是怎么工作的。
你这个问题问得不太合理,开发文档要写很多东西,而你要让程序员看懂这个项目的话,只要写交互图就可以了,至于项目的框架式怎么工作的,只要告诉程序员是什么框架就可以了,程序员应该会使用框架
2. 自己写Java文档一般需要有哪些内容
每个非 private 方法的参数说明,像 getter/setter 这样简单的就省略掉。主要是关键方法和类的设计要有说明。另外,一些方法有内部的实现约定,也就是前提条件,这个在技术上没办法验证的或验证它会影响性能等,我们就只在文档中说明,不在代码中检查了。举个例子,java.util.ArrayList 不是一个线程安全的集合实现类,它就在文档中说明了这点,另一个就是 equals 和 hashcode 方法在你覆盖它时应该同时按相同的算法覆盖两个,只覆盖一个就不符合设计约定。再一个就是简要说明你的关键方法和类是如何设计的。
一个好的文档可以用来回答 What, Why & hoW 这三个 W。
3. java api文档中文版
Java EE 6的是没有中文的:
http://www.just4e.com/javaee-6/docs/index.html
另外这里能找到绝大多数的Java文档,给你参考一下:
http://www.just4e.com/
4. java范例开发大全的文档
http://java.sun.com/j2se/1.5.0/docs/api/index.html
http://gceclub.sun.com.cn/Java_Docs/html/zh_CN/api/index.html
5. 以太坊开发:如何在Windows下开发一个简易Da
我的电脑->属性->高级->环境变量->系统变量中添加以下环境变量:
JAVA_HOME值为:安装JDK的目录, 我的为C:\Program Files\Java\jdk1.6.0_34
CLASSPATH值为:.;%JAVA_HOME%\lib\tools.jar;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\bin;(注意前面的".;"要加上)
Path: 在开始追加 .;%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin;(注意前面的".;"要加上)
安装完成之后,可以在检查JDK是否安装成功。打开cmd窗口,输入java –version 查看JDK的版本信息。
6. Java网站功能技术文档该如何写
有操作手册和设计文档两种,如果是操作手册,就从前台,每一步,该从哪里开始,点击之后,会出现什么,下一步如何操作,就是这样.设计文档就是根据流程,每一步具体怎么实现,所用到哪些技术,具体的实现方法是什么,实现类的路径.
7. 怎么用javadoc生成api文档
javadoc -d myfill -autor -version api.java
myfill是创建的文档存放位置,名字随便起,-autor是作者名 -version是版本号 api.java 是java文档的路径 如果有包要带上包名,这里我创建了一个java学习群前面是六六5中间是六一7后边是150,想学好的可以进来。
8. java中说明书/开发文档如何编写
由于在java开发时我们得到的或者给别人的文件一般都是class文件,不会给出源文件,故编写一个简洁易懂的说明书是必须的。
ps:@param int[] arr 会有警告,可以删掉 int []。
用工具解析文档注释:javadoc工具
javadoc -d 目录 -d -author -version ArrayTool.java
有时会提示出错:找不到可以文档化的公共或受保护的类-->在class前加一个public即可。
9. 如何书写Java项目的开发文档
现在很多文档的编写均有自己的固定格式,这方面网络文库里面就有不少可以参考的文档模板。现在以Java方向的文档为主,简单结束一下。
1人员流动是项目进行中比较让人头疼的事情。做好规范文档,可以让代码看起来比较像出自同一人之手。
2要做java开发文档得做不少功夫,有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范,这样,及时有人员流动的话,新人看了文档,也能比较快的了解功能需求、数据库设计、编码规范,更快的上手项目。
3先看看你需要什么文档,然后去文库里搜索,就有相应的模板,找个适合自己项目的模板用。
10. 做完JAVA项目后,要求写一份DOC技术文档说明这个项目,怎么写
先写修订的人
然后写这个项目是为了做什么的
然后用到的技术栈
然后详细介绍功能 如果是web项目就先介绍各个接口,需要的参数
然后如果时间允许,把几个重要的表 建模截图放进去