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

╰半夏微凉° 2021-12-15 20:34 501阅读 0赞

### 文章目录 ###

*   *  1. 引入依赖包
     *  2. 单独运行一个java文件
     *  3. 修改class的模板
     *  4. 生成javadoc
     *  5. git版本控制
     *  6. 操作数据库
     *  7. ctrl + 点击 可跳转到类的实现处
     *  8. 设置终端
     *  9. 设置代理
     *  10. 格式化html
     *  11. Sphinx 自动生成python文档
     *  12. 使用read the Doc 托管文档
     *  13. IDEA补全快捷键
     *   *  1. for循环
         *  2. main函数补全
         *  3.System.out.println();
         *  4. 按ctrl+j查看所有代码生成
         *  5. 自定义自己的快捷键
         *  6. 技能表
     *  14. 使用mkdocs生成快速文档
     *  15. github gist

## 1. 引入依赖包 ##

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

## 2. 单独运行一个java文件 ##

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

## 3. 修改class的模板 ##

如加入作者, 时间等信息  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 2]

## 4. 生成javadoc ##

刚学java, 知道了这个工具觉得好神奇啊, 居然这么方便开发者.  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 3]  
效果如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 4]  
不过在我的电脑上, 用jdk11生成不了, 得换成jdk8.

## 5. git版本控制 ##

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

## 6. 操作数据库 ##

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

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

## 8. 设置终端 ##

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

## 9. 设置代理 ##

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

## 10. 格式化html ##

原先  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 11]  
`Code->Reformat Code` 快捷键 `Ctrl+Alt+L`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 12]

## 11. Sphinx 自动生成python文档 ##

[官网: http://www.sphinx-doc.org/en/master/\#confval-language][http_www.sphinx-doc.org_en_master_confval-language]

[sphinx\_rtd\_theme 主题github][sphinx_rtd_theme _github]

[简书上的好教程][Link 1]

效果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 13]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 14]

安装  
`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][conf.py], 取消注释, 路径改成自己项目路径  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 15]  
修改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包的文档都是托管到这的?  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 16]

## 13. IDEA补全快捷键 ##

### 1. for循环 ###

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

### 2. main函数补全 ###

输入psvm然后回车  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 17]

### 3.System.out.println(); ###

输入sout, 回车  
![在这里插入图片描述][20190708231549194.png]

### 4. 按ctrl+j查看所有代码生成 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 18]  
[参考: https://juejin.im/entry/5a0eaf38f265da431955d9a6][https_juejin.im_entry_5a0eaf38f265da431955d9a6]

### 5. 自定义自己的快捷键 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 19]  
[https://blog.csdn.net/qq\_27093465/article/details/52691572][https_blog.csdn.net_qq_27093465_article_details_52691572]

### 6. 技能表 ###

[https://www.cnblogs.com/jx17/p/6244491.html][https_www.cnblogs.com_jx17_p_6244491.html]

## 14. 使用mkdocs生成快速文档 ##

mkdocs能够根据markdown快速生成文档网站, 然后部署在github page上, 这样可以给每个项目都部署一个文档网站了  
[比如这个文档页面, 就是我用来测试mkdocs效果的页面][_mkdocs]  
效果如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 20]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 21]  
可以方便地更换各种主题

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

输入命令`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

## 15. github gist ##

代码片段管理服务

今天偶然知道了github还提供这样一个服务, 之前知道贴代码可以用Pastebin.

简而言之就是大家可以把自己的代码片段贴上去, 然后分享. 支持匿名, 私密, markdown等.  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 22]

而且我突然发现之前我colab上有一个选项保存到github gist上就是这个! 恍然大悟.  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 23]  
在gist链接后面加一个`.pibb`后缀, 直接将这部分内容变成一个干净的html网页了.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70]: /images/20211215/546b40b076604f4e840641c792f0a448.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 1]: /images/20211215/216e023169e34927b36fc343d9138b7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 2]: /images/20211215/08b1ede4e24b4769864ed11b62b84dd5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 3]: /images/20211215/c8249da21cdf4bada3e8fbe45f7ce712.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 4]: /images/20211215/d7b2655c7eac4f2a9b8ba534c202a329.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 5]: /images/20211215/1fd8ae083ae94d4d8840cd33c00460b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 6]: /images/20211215/681f24914d2e4144a9beb9eb5ddf3102.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 7]: /images/20211215/d5a8fea6954142aba97d30d105a72a20.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 8]: /images/20211215/e43eb6389964492aa399884f6f343825.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 9]: /images/20211215/07d80e62196147328409a84c48e18293.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 10]: /images/20211215/4fb64826894841ba9514223dc5cb4cba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 11]: /images/20211215/33e2ad946f6a4eda9072d2998bcf4cf9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 12]: /images/20211215/c0d6118cdc96469cbce9043ac5d8d96f.png
[http_www.sphinx-doc.org_en_master_confval-language]: http://www.sphinx-doc.org/en/master/#confval-language
[sphinx_rtd_theme _github]: https://github.com/readthedocs/sphinx_rtd_theme
[Link 1]: https://www.jianshu.com/p/d4a1347f467b
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 13]: /images/20211215/0d3ff9c919dc442fa9a0dc0c5b73998c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 14]: /images/20211215/cb0c45d224f14faa89cf29842a4915df.png
[conf.py]: http://xn--conf-pm9fq77f.py
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 15]: /images/20211215/eb507e8873db4576885fc8b4d9553238.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 16]: /images/20211215/7e5633ff6f894bc5b63a5f370cee103d.png
[20190708231337568.png]: /images/20211215/3041caa0fad84a42884e56ba98b081f3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 17]: /images/20211215/61edbe71f78944e3867add5c1926cb0d.png
[20190708231549194.png]: /images/20211215/46c91b51194941fe906c67f31abfb9e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 18]: /images/20211215/62c9985b345340358ceb03d949f87cc3.png
[https_juejin.im_entry_5a0eaf38f265da431955d9a6]: https://juejin.im/entry/5a0eaf38f265da431955d9a6
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 19]: /images/20211215/62d9470eea3142ad90c17dee36561863.png
[https_blog.csdn.net_qq_27093465_article_details_52691572]: https://blog.csdn.net/qq_27093465/article/details/52691572
[https_www.cnblogs.com_jx17_p_6244491.html]: https://www.cnblogs.com/jx17/p/6244491.html
[_mkdocs]: https://fiveplus.top/hello-world/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 20]: /images/20211215/621240a7d2f8463b90f02566a66bfe7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 21]: /images/20211215/76404a905a8c4132bb54401c2e8de6ea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 22]: /images/20211215/0ac460b4e7b74cc5ad9534866b769e86.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dqaDI2MjIwNzUxMjc_size_16_color_FFFFFF_t_70 23]: /images/20211215/e8473d6a29b74d1695f68bde82e25e81.png