IDEA及其他开发工具日常使用指南

最新推荐文章于 2025-08-09 20:20:29 发布

原创最新推荐文章于 2025-08-09 20:20:29 发布 · 1.1k 阅读

26 ·

CC 4.0 BY-SA版权

文章标签：

#java #idea

java 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了一系列提升IDEA开发效率的方法，包括依赖包引入、Java文件运行、代码模板定制、javadoc生成、git版本控制、数据库操作、快捷键使用、mkdocs及Sphinx文档生成等，适用于Java和Python开发人员。

1. 引入依赖包

通过如图所示的路径添加tar文件, 即可引入外部包.
在这里插入图片描述

2. 单独运行一个java文件

在java文件上右键, 如果你写好了main函数就可以编译运行. 之前由于不熟悉java, 所以main的参数没有写String[] args, 所以一直无法运行.
在这里插入图片描述

3. 修改class的模板

如加入作者, 时间等信息
在这里插入图片描述

4. 生成javadoc

刚学java, 知道了这个工具觉得好神奇啊, 居然这么方便开发者.
在这里插入图片描述
效果如图

不过在我的电脑上, 用jdk11生成不了, 得换成jdk8.

5. git版本控制

在idea上进行版本控制很方便
在vcs这一栏开启之后就可以用git了.
有比较友好的图形操作界面.
在这里插入图片描述

6. 操作数据库

在view这一栏找到工具, 配置好数据库就可以连接了.
在这里插入图片描述
然后在窗口上写sql语言, 下面的console就出现结果

7. ctrl + 点击可跳转到类的实现处

8. 设置终端

cmd真难受, 换成powershell好用多了
在这里插入图片描述

9. 设置代理

应该就不用每次都在代码里面弄了, scrapy配置socks真是麻烦死了啊.
在这里插入图片描述

10. 格式化html

原先
在这里插入图片描述
Code->Reformat Code 快捷键 Ctrl+Alt+L

11. Sphinx 自动生成python文档

官网: http://www.sphinx-doc.org/en/master/#confval-language

sphinx_rtd_theme 主题github

简书上的好教程

效果
在这里插入图片描述

安装
pip install sphinx
mkdir doc_test
cd doc_test
执行sphinx-quickstart
下面是配置

PS C:\Users\姬小野\PycharmProjects\get_nlp_data\doc_test> sphinx-quickstart
Welcome to the Sphinx 2.1.2 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: n

The project name will occur in several places in the built documentation.
> Project name: NLP_Books
> Author name(s): Jamey
> Project release []: v0.6

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]: zh_cn

Creating file .\conf.py.
Creating file .\index.rst.
Creating file .\Makefile.
Creating file .\make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file .\index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

PS C:\Users\姬小野\PycharmProjects\get_nlp_data\doc_test>

找到conf.py, 取消注释, 路径改成自己项目路径
在这里插入图片描述
修改extensions为如下

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode'
]

执行
sphinx-apidoc -o ./source ../
其中 ./source 为rst文件所在目录

使用make 查看可用的make命令
这里我们make html

12. 使用read the Doc 托管文档

看这网站logo, 难道大多数python包的文档都是托管到这的?
在这里插入图片描述

13. IDEA补全快捷键

1. for循环

打一个for循环, 些fori, 然后回车, 马上就有
在这里插入图片描述

2. main函数补全

输入psvm然后回车
在这里插入图片描述

3.System.out.println();

输入sout, 回车
在这里插入图片描述

14. 使用mkdocs生成快速文档

mkdocs能够根据markdown快速生成文档网站, 然后部署在github page上, 这样可以给每个项目都部署一个文档网站了
比如这个文档页面, 就是我用来测试mkdocs效果的页面
效果如图
在这里插入图片描述

可以方便地更换各种主题

甚至可以单独把它作为一个博客网站来玩

输入命令mkdocs -h 即可查看他的功能

(torch)$  mkdocs -h
Usage: mkdocs [OPTIONS] COMMAND [ARGS]...

  MkDocs - Project documentation with Markdown.

Options:
  -V, --version  Show the version and exit.
  -q, --quiet    Silence warnings
  -v, --verbose  Enable verbose output
  -h, --help     Show this message and exit.

Commands:
  build      Build the MkDocs documentation
  gh-deploy  Deploy your documentation to GitHub Pages
  new        Create a new MkDocs project
  serve      Run the builtin development server