NetBeans中Javadoc与版本控制的使用指南

# NetBeans中Javadoc与版本控制的使用指南 ## 1. 访问Javadoc NetBeans不仅提供了为项目创建Javadoc的工具，还具备多种功能，可帮助我们快速便捷地访问现有的Javadoc。 ### 1.1 附加到库和平台 若项目使用了第三方库，可考虑附加相关的Javadoc，这样能快速访问代码文档，加快开发进程。 - **添加库**：NetBeans允许将一个或多个JAR文件指定为库，这是组织第三方JAR文件的好方法。可定义要执行的二进制类文件、匹配的源代码以及Javadoc文档的路径。操作步骤如下： 1. 选择“Tools” -> “Library Manager”。 2. 在“Library Manager”中，可添加新库、移除库或修改现有库。该窗口有三个选项卡用于管理库、类路径、源代码和Javadoc。 3. 每个选项卡允许为类文件、源代码或Javadoc添加对一个或多个JAR或zip文件的引用。若Javadoc位于某个目录中，可使用“Javadoc”选项卡添加对该目录的引用。 - **为平台添加Javadoc**：也可为NetBeans中定义的每个Java平台添加Javadoc。下载并安装JDK时，应确保同时下载源代码和Javadoc，这对新手程序员尤其有价值。操作步骤如下： 1. 选择“Tools” -> “Java Platform Manager”。 2. 在该窗口中，可查看NetBeans配置的默认平台以及可能安装的任何其他平台。 3. 每个平台的窗口有三个选项卡：“Classes”、“Sources”和“Javadoc”。最初添加新平台时，JAR文件应已自动添加。需要在每个选项卡上手动引用源代码和Javadoc。 ### 1.2 查看上下文相关的Javadoc 在代码编辑过程中，可查看上下文相关的Javadoc，直接在“Source Editor”窗口中快速访问文档和使用信息。查看方式如下： - **代码补全时查看**：若启用了代码补全功能，在包或类名后输入句点时，代码补全框会出现。对于代码补全框中突出显示的Java元素，还会出现一个额外的弹出窗口，显示当前所选元素的Javadoc。使用键盘箭头键在列表中上下滚动时，Javadoc窗口会相应更新。 - **强制显示Javadoc窗口**：突出显示要查看Javadoc的类或包，然后按“Ctrl + Shift + 空格键”，弹出窗口将显示所选项目的Javadoc。 - **右键查看**：也可突出显示或选择一个元素，然后右键单击。在出现的上下文菜单中有一个名为“Show Javadoc”的选项。若未将Javadoc附加到元素所属的库或平台，将在“Source Editor”窗口底部看到状态消息“Javadoc Not Found”。 ### 1.3 搜索Javadoc “Javadoc Search”工具可快速方便地搜索在NetBeans中注册的Javadoc。操作步骤如下： 1. 若在“Source Editor”中编写代码，突出显示要在搜索工具中显示的术语，然后按“Shift + F1”。也可通过选择“Tools” -> “Javadoc Index Search”访问“Javadoc Search”工具。 2. “Javadoc Search”窗口分为搜索和查看两部分。顶部窗格允许根据部分名称匹配搜索Javadoc元素。 3. 在搜索字段中输入要搜索的短语后，按“Enter”键或单击搜索字段旁边的“Find”按钮。 4. 该工具会扫描所有已知的Javadoc并显示结果。若在列表中选择任何结果，匹配的Javadoc页面将显示在下部窗格中。可通过单击“View Source”按钮直接跳转到元素的源代码。还可通过单击相应按钮按名称、包和类型对搜索结果进行排序。还有一个按钮可切换HTML查看器窗口（下部窗格）的显示。将鼠标悬停在每个按钮上可查看描述其功能的工具提示。 ## 2. 管理版本控制 软件开发的一个重要方面是控制源代码。在单开发者和多开发者项目中，将文件存储在开发者计算机之外的地方以确保代码的长久性至关重要，同时能够跟踪单个源文件的版本并控制更改也很重要。 ### 2.1 使用CVS CVS允许将项目备份到开发机器之外的系统中，可存储文件、管理代码的各个唯一版本，并在需要时检索这些版本。NetBeans的CVS模块提供了所有这些功能。 - **启用CVS**：NetBeans初始安装时，默认启用对CVS的支持，在NetBeans菜单栏上应能看到“CVS”菜单。若安装了其他版本控制系统模块（如Subversion），CVS模块可能会被禁用。若CVS模块被禁用（且未使用其他版本控制系统），可使用“Module Manager”启用它。操作步骤如下： 1. 选择“Tools” -> “Module Manager”。 2. 在“Module Manager”的“Version Control”节点下，会看到“CVS Versioning System”选项。 3. 在“Active”列的复选框中打勾以启用它。 ### 2.2 配置项目以使用CVS 可通过以下两种主要方式在NetBeans项目中开始使用CVS： - **将新项目导入CVS存储库**：若有新的或现有的NetBeans项目，可将其导入存储库。操作步骤如下： 1. 在“Projects”窗口中右键单击项目，选择“CVS” -> “Import into Repository”。 2. 在出现的“Import Project Options”窗口的第一步“CVS Root”中，若不熟悉设置CVS根目录，可单击该字段旁边的“Edit”按钮，使用“Edit CVS Root”对话框输入字符串。在“Edit CVS Root”对话框中，从“Access Method”下拉列表中选择一种方法，有四个选项： - “pserver”：允许使用用户名和密码连接到远程服务器。 - “ext”：与“pserver”类似，但使用安全外壳（SSH）。 - “local”：允许连接到本地运行的源代码存储库。 - “fork”：是“local”的替代版本。 3. 在“Edit CVS Root”对话框中，还需填写“User”、“Host”、“Port”和“Repository Path”字段。“User”字段中输入在代码存储库中分配的用户名，“Repository Path”值通常格式为“/cvsroot/myproject”。输入值后，单击“OK”返回“Import Project Options”窗口，字符串将显示在“CVS Root”字段中。 4. 配置好正确的CVS根字符串后，在“CVS Root”窗口中单击“Next”。NetBeans将尝试验证连接，然后显示下一步“Folder to Import”。 5. 在该窗口中，指定要导入的本地机器上的项目文件夹，通常已设置为NetBeans项目的根文件夹。还可指定存储库文件夹，即模块将在CVS存储库中放置的名称。完成后，单击“Finish”按钮。 - **从存储库检出代码**：对于现有项目，可能需要从存储库检出代码。操作步骤如下： 1. 选择“CVS” -> “Checkout”。 2. 在出现的第一个窗口中，指定CVS根字符串，然后单击“Next”按钮。 3. 在“Module to Checkout”窗口中，需指定多个属性。“Module”是要从存储库下载的实际代码。若知道模块名称，可直接在“Module”字段中输入；也可单击“Module”字段旁边的“Browse”按钮，浏览存储库并从列表中选择模块。 4. 还可选择使用CVS分支或标签检出代码，若存储库中使用了这些。单击“Branch”字段旁边的“Browse”按钮，打开“Browse Tags”对话框。若没有要使用的特定分支或标签，单击“HEAD”节点，然后单击“OK”按钮。 5. 在“Module to Checkout”窗口中，还需指定代码将复制到的本地文件夹。设置好属性后，单击“Finish”按钮，检出操作将开始。 6. 检出操作完成后，将看到一个对话框，提示检出已完成，并询问是否要打开项目或关闭窗口。若单击“Open Project”按钮，对话框将关闭，项目将显示在“