java开发文档编写

1. 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; } }

2. java面试官问有没有写过文档（面试java程序员）,我想知道写文档是指什么,是设计文档还是需求文档还是其他

我想他的文档是指在项目开发过程中 不同阶段的文档

我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ，操作手册 (这个也算)
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的...文档编写时间 主要是代码开发前 与 转测试后

3. java 项目需求文档要怎么写

5.在线预览、分享更便捷

在摹客中在线撰写或上传的产品需求文档，可通过链接快速分享给团队成员，团队成员获得链接后可自由查看，当产品需求文档有修改时，团队成员仍可通过链接查看最新版本。

使用摹客等高效便捷的产品文档撰写工具，可以简化产品文档撰写流程，提升产品经理的文档撰写能力，让产品经理事半功倍。

总结

产品需求文档作为产品开发团队的重要沟通文档，文档的质量好坏会直接影响到各部门是否能够明确产品的功能和逻辑。一份简洁易懂、逻辑清晰的产品需求文档，可以让团队沟通更加高效，从而有效提高产品开发团队的工作效率。

4. 编写和运行Java程序的步骤是什么每一步的结果是什么在JDK中,Java语言的编译命令是什么急需答案啊。

步骤：1、编写java源文件：可用记事本等相关的文本文档写源代码，也可使用java开发集成环境，如：JCreator LE JCreator pro eclipse Myeclipse 等相关的集成开发工具。

2、编译java源文件生成class文件：手写的源文件（即不使用开发工具所写的），在DOS中使用javac 完整的java源文件命来编译使其生成class文件。注意：写源文件时，一定要注意存档。修改源文件也是一样需要存档。

3、运行class文件：在dos中输入所写的源文件名字（不需要写后缀名-即.class 严格区分大小写 编译不需要区分大小写）。

如使用开发工具所写：请参照相对应的手册来点击开发工具中的按钮来编译运行。
java语言的编译命令就是javac 在dos中输入javac可见到这个命令的详细介绍。其他命令也是一样。至于每一步的结果是什么，在dos中运行请关注dos运行后的变化。在开发工具中运行请关注开发工具中的改变。不同的程序会产生不同的结果。如：
public class Hello
{
public static void main(String[] args)
{
System.out.println("Hello java");
}
}
这段代码，在dos中运行后会出现hello java这句话。用开发工具所写 ，请关注开发工具的界面。

以上内容纯属手打--panzer。希望对你有所帮助。如有疑问：开eml我：[email protected]！

5. Java这个怎么编

• 为了在您的机器上配置起一个Java开发环境——您将使用一个“开发环境”来“开发”（编写）程序——您需要完成以下这些步骤：

  1.下载一个包含Java开发环境（编译器和其他工具）的大文件。点击“下载J2SE SDK”链接下载SDK（软件开发工具包）软件。网页会显示一个许可协议。点击“接受”。选择您的操作系统，然后将文件保存到下载目录中。这是一个巨大的文件，用电话调制解调器下载需要好几个小时。接下来的两个文件也很大。

  2.下载一个包含Java文档的大文件。选择操作系统后点击SDK1.4.1文档的链接。

  3.如果您的机器上还没有安装WinZip（或可执行相同功能的程序），那么您需要下载一个包含WinZip的大文件并安装之。如果您的机器上没有安装某个的版本的WinZip或其他解压缩软件，下载WinZip的试用版。运行EXE文件安装。很快我们将使用它来安装文档。

  4.安装Java开发环境。运行第一步下载的j2sdk-1_4_1-*.exe文件。他将自动解压并安装开发工具包。

  5.安装文档。阅读安装说明文档。它会要求您将文档文件移至刚才开发工具包的安装目录。将文档解压缩，文件就会被安排到适当的位置。

  6.调整环境变量。按照此页的要求，您需要改变路径变量。最简单的办法是打开一个MS-DOS窗口键入PATH看看当前的路径变量是什么，然后用记事本打开autoexec.bat按要求修改PATH环境变量。

  7.全面测试。现在您应该可以打开另一个MS-DOS窗口并键入javac了。如果一切设置妥当，那么您将看到屏幕将输出两行文字告诉您如何使用javac。这意味着一切已经准备就绪了。如果您看到“错误的命令或文件名”这条消息，则说明还没有准备好。请重新阅读安装说明检查哪里出了问题。确定PATH被正确设置并可用。回头重新阅读上面的步骤，问题不解决不要轻易放弃。现在您已自豪地拥有一台能够编译Java程序的机器了。您已经准备好开始编写软件了！

• 顺便指出，刚才您解压缩的内容包括一个demo（演示）目录，其中包含许多精致的例子。所有的例子都可以立即执行，所以您不妨找到这个目录试运行一下其中的某些例子。许多例子都会发声，所以请打开扬声器。要运行例子，找到名如example1.html的网页文件并使用您常用的浏览器打开即可。

• 您的第一个程序将是小巧可爱的。它将建立一个绘图区域并在其上绘制一条对角线。创建此程序您需要：

  1.打开记事本键入（或复制粘贴）程序 。建立一个新目录以保存程序。打开记事本（或其他可以创建TXT文件的文本编辑器）。将范例程序录入或复制粘贴到记事本窗口中。切记：输入程序的大小写敏感。因此必须按照范例程序中字母的大小写输入。重审以上编程步骤。如果录入内容和范例程序不是完全一致，则程序将无法正常运行。

  2.保存程序 。将文件在第一步创建的路径下保存，文件名为FirstApplet.java。文件名大小写敏感。请确保字母“F”和“A”大写，其他字母小写，如前所示。

  3.使用Java编译器编译程序生成一个Java程序 。

  打开一个MS-DOS窗口。改变至包含FirstApplet.java的路径下（cd），键入：
  javac FirstApplet.java

  记住大小写敏感！或者编译成功，这时屏幕不输出任何信息，或者有错误发生。若没有错误，则会在目录里生成一个名为FirstApplet.class的文件与FirstApplet.java并列。

  （请确保程序保存的文件名为FirstApplet.java而不是FirstApplet.java.txt。最简单的办法就是在MS-DOS窗口下键入dir然后查看文件名。若扩展名是.txt 则请重命名文件去掉此扩展名。也可以运行Windows资源管理器在“查看”菜单下点击“选项”。确保“隐藏已注册的MS-DOS文件扩展名”选项处于未选中状态，然后在资源管理器中查看文件名。若需要则将文件改名。）

  4.排除问题。若有问题产生则想办法解决。将您的程序与上面的范例程序对比，使之完全相同。修改过程中不断编译程序，直到没有错误发生。

  5.建立一个HTML网页“包含”刚创建的Java程序 。

  创建一个HTML页面来包含小程序。另开一个记事本窗口。录入下面的内容：

  将此文件存于同一目录中，文件名为applet.htm。

  

• 1.运行Java程序 。

  在您的MS-DOS窗口中键入：
  appletviewer applet.htm

  应该可以看见一条从左上角到右下角的对角线：（如上图所示）

  将小程序查看器的窗口拉大一些以查看整条对角线。您也可以将此HTML网页装载到任何现用的浏览器中，如Netscape Navigator或微软IE，看到的结果是大致相同的。

  使用Java语言编程就需要一个Java编译器。下一节将指导您下载并安装一个编译器。一旦有了编译器我们就可以开始学习编程了。下载和安装过程将会持续几个小时，大部分时间用来下载几个很大的文件。您还需要有大约40兆字节的空闲磁盘空间（开始前请确定有足够的空间）。

  这里是本节的示范程序：
  import java.awt.Graphics;
  public class FirstApplet extends java.applet.Applet
  {
  public void paint(Graphics g)
  {
  g.drawLine(0, 0, 200, 200);
  }
  }

河南新华

6. 如何用java开发类似word文档的软件

在探索基于Web的文档编辑器的过程中，我发现了canvas-editor这款开源编辑器，其底层基于canvas实现，非常适合开发类似于Word文档编辑器的软件。

通过使用canvas-editor，你可以实现与Word类似的效果，并且它提供了丰富的自定义API，让你可以定制属于自己的文档编辑平台。如果你正打算着手开发，那么canvas-editor将是一个很好的选择。

该项目由国内的大佬维护，你也可以通过点赞表达支持。

接下来，我将展示使用canvas-editor开发的编辑器效果。

你将看到插入表格、插入公式等操作，这些都与在Word中编写文档时的体验非常相似。

以下是canvas-editor的一些功能点介绍：

使用canvas-editor，你不仅可以享受到丰富的功能，还可以根据自己的需求进行更自由的配置。例如，你可以根据提供的配置实现更高级的编辑功能。

此外，canvas-editor提供了丰富的API，你可以通过查阅文档来了解更多。

如果你对这款编辑器感兴趣，可以访问其GitHub页面进行深入研究和使用。