H5W3
当前位置:H5W3 > java > 正文

【Java】Android Studio & IDEA工程文档编写

Android Studio & IDEA工程文档编写

BenHero发布于 2 月 5 日

今天在梳理接手的工程时候,想让写一个ReadMe文档,并且可以跳转打开一些文件,比如某些关键类。先看效果:
【Java】Android Studio & IDEA工程文档编写

这个效果很大地满足了我的需求。为了达到这个效果,需要具备2个知识点:

  1. Markdown语法: 不了解同学的可以百度下,不到10分钟你就可以成为一个Markdown入门选手
  2. 跳转文件链接的配置

Markdown配置与语法

  1. 安装Markdown插件:Preferences→Plugins->Marketplace→安装Markdown插件,重启Android Studio
  2. 在工程目录中适当的位置创建以”README.md”文件(以md结尾的Markdown文件即可)
  3. 复制下面这段md,按住Ctrl + 鼠标左键 or Command + 鼠标左键,即可跳转打开指定的文件,包括文件夹

Markdown基础语法:

  1. 代表着标题,几个#代表这个几级的标题

  2. [显示的文本](跳转的链接):中拓号用于显示预览的文本,括号内是链接地址,可以网址,也可以是本文中的文件地址

上文动图,可以参考本人GitHub工程

文件引用路径的生成

上面动图使用到的文件路径[app/src/main/java/com/ben/template/XApplication.kt],有一定的规则:必须是从项目的根目录作为起始路径,而不是在电脑系统中的绝对路径。所以这里要使用一个命令:Path From Respository Root,可以通过以下2个方式去找到

  1. 菜单栏→Edit→Copy找到
  2. 设置项Preferences→Keymap→直接搜索并添加快捷键

其他

  1. Markdown推荐编辑器:马克飞象 这个编辑器是我入坑Markdown以来一直在用的,渲染效果好,可以导出pdf、md、html。
  2. Android Studio上还可以通过Favorites面板来保存需要的文件,也可以通过书签Bookmarks来保存,有相应的快捷键

GitHub工程

javaandroidkotlinandroid-studio
阅读 18发布于 2 月 5 日
本作品系原创,采用《署名-非商业性使用-禁止演绎 4.0 国际》许可协议
avatar

BenHero

喜欢Android

468 声望
5 粉丝

0 条评论
得票时间

avatar

BenHero

喜欢Android

468 声望
5 粉丝

宣传栏

今天在梳理接手的工程时候,想让写一个ReadMe文档,并且可以跳转打开一些文件,比如某些关键类。先看效果:
【Java】Android Studio & IDEA工程文档编写

这个效果很大地满足了我的需求。为了达到这个效果,需要具备2个知识点:

  1. Markdown语法: 不了解同学的可以百度下,不到10分钟你就可以成为一个Markdown入门选手
  2. 跳转文件链接的配置

Markdown配置与语法

  1. 安装Markdown插件:Preferences→Plugins->Marketplace→安装Markdown插件,重启Android Studio
  2. 在工程目录中适当的位置创建以”README.md”文件(以md结尾的Markdown文件即可)
  3. 复制下面这段md,按住Ctrl + 鼠标左键 or Command + 鼠标左键,即可跳转打开指定的文件,包括文件夹

Markdown基础语法:

  1. 代表着标题,几个#代表这个几级的标题

  2. [显示的文本](跳转的链接):中拓号用于显示预览的文本,括号内是链接地址,可以网址,也可以是本文中的文件地址

上文动图,可以参考本人GitHub工程

文件引用路径的生成

上面动图使用到的文件路径[app/src/main/java/com/ben/template/XApplication.kt],有一定的规则:必须是从项目的根目录作为起始路径,而不是在电脑系统中的绝对路径。所以这里要使用一个命令:Path From Respository Root,可以通过以下2个方式去找到

  1. 菜单栏→Edit→Copy找到
  2. 设置项Preferences→Keymap→直接搜索并添加快捷键

其他

  1. Markdown推荐编辑器:马克飞象 这个编辑器是我入坑Markdown以来一直在用的,渲染效果好,可以导出pdf、md、html。
  2. Android Studio上还可以通过Favorites面板来保存需要的文件,也可以通过书签Bookmarks来保存,有相应的快捷键

GitHub工程

本文地址:H5W3 » 【Java】Android Studio & IDEA工程文档编写

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址