「看懂java开发文档」java编写文档

今天给各位分享看懂java开发文档的知识，其中也会对java编写文档进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、请高手指教，一个java WEB项目的开发文档要怎么写，让别的程序员一看就明白这个项目的框架是怎么工作的。
• 2、如何书写Java项目的开发文档
• 3、怎样看懂java的api文档？ 有没相关案例看看？ 诶，百分之99都看不懂
• 4、java中说明书/开发文档如何编写
• 5、Java文档怎么看?

请高手指教，一个java WEB项目的开发文档要怎么写，让别的程序员一看就明白这个项目的框架是怎么工作的。

你这个问题问得不太合理，开发文档要写很多东西，而你要让程序员看懂这个项目的话，只要写交互图就可以了，至于项目的框架式怎么工作的，只要告诉程序员是什么框架就可以了，程序员应该会使用框架

如何书写Java项目的开发文档

我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。。

人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。

怎样看懂java的api文档？ 有没相关案例看看？ 诶，百分之99都看不懂

Java的api文档包含了所有基础类的构造方法、方法等说明，它不是直接拿来看的，而是作为一种查询工具、帮助文档来帮助用户的。

比如你在开发程序或者查看别人写的代码的时候，遇到没有见过的类、方法的时候就可以通过API文档来搜索该方法，进而了解到这里使用该方法的原因。

java中说明书/开发文档如何编写

由于在java开发时我们得到的或者给别人的文件一般都是class文件，不会给出源文件，故编写一个简洁易懂的说明书是必须的。

ps： @param int[] arr 会有警告，可以删掉 int []。

用工具解析文档注释：javadoc工具

javadoc -d 目录 -d -author  -version ArrayTool.java

有时会提示出错：找不到可以文档化的公共或受保护的类--在class前加一个public即可。

Java文档怎么看?

不是，MSDN是MICRO的．与JAVA相关的很多都能被称为JAVA文档．最常见的是J2SE SDK的文档．你可以在java.sun.com上获得．帮助文档看你选用的开发工具而定．

看懂java开发文档的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java编写文档、看懂java开发文档的信息别忘了在本站进行查找喔。