android studio下编写README.md文件

效果截图:

README.md的编写:

1、标题写法:关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号  #  的个数来标识的。
(**内容写在#号后,#号与内容之间要有1个及以上空格。** 1-6个#代表1-6级字体的大小)

#  一级标题
##  二级标题
###  三级标题
####  四级标题
#####  五级标题
######  六级标题

**使用前一定要导入Gauge插件后重启android studio使用以下符号编写README.md文档**

2、字体格式强调:我们可以使用下面的方式给我们的文本添加强调的效果(**内容写在*号之间**,1个*代表斜体,2个代表粗体,3个代表粗斜体)

*强调*  (示例:斜体)

**加重强调**  (示例:粗体)

***特别强调*** (示例:粗斜体)

3、代码(**内容写在`之间**)

`<hello world>`

4、代码块高亮(**内容写在```之间**)

```
@Override
protected void onDestroy() {
    EventBus.getDefault().unregister(this);
    super.onDestroy();
}
```

5、表格 (建议在表格前空一行,否则可能影响表格无法显示。表头用|分开,表头下用----|----|表示,内容用|分开)

表头|表头 |表头
----|-----|------
单元格内容|单元格内容|单元格内容
单元格内容|单元格内容|单元格内容
单元格内容|单元格内容|单元格内容

6、其他引用

图片:
![百度](https://www.baidu.com/img/bd_logo1.png)

链接:
[百度一下,你就知道](https://www.baidu.com/)

7、列表(**用数字加点表示,点后面要有1个及以上空格。加空心圆点的用星号表示,星号号前空格要3格或3格以上,星号后要1个及以上空格要不然会是实心圆点**)

1. 项目1
2. 项目2
3. 项目3

   * 项目1 (一个*号会显示为一个黑点,注意⚠️有空格,否则直接显示为*项目1)
   * 项目2

8、引用(**用>号表示**)

> 第一行引用文字

> 第二行引用文字

 

创建微服务时没有README.md文件可能有几个原因。首先,README.md文件通常是用来提供项目的说明和使用指南的,特别是在公开项目或商业项目中。如果微服务是作为内部使用的项目,可能没有必要编写README.md文件。其次,有时候项目的创建者可能忘记或没有意识到编写README.md文件的重要性。最后,有些开发者可能认为项目的结构和代码本身已经足够清晰,不需要额外的文档来解释。 然而,创建微服务时编写README.md文件是一个良好的实践,它可以帮助其他开发人员更好地理解项目的目的、功能和使用方法。README.md文件可以提供项目的概述、安装和配置说明、使用示例、贡献指南等信息,有助于提高项目的可维护性和可理解性。因此,为了更好地与他人合作和共享项目,编写一个清晰、详细的README.md文件是非常有益的。 #### 引用[.reference_title] - *1* *3* [一文带你写好:项目说明文档README.md](https://blog.csdn.net/qq_29166327/article/details/130550728)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [经验分享:给项目创建和编写README.md文件的步骤](https://blog.csdn.net/weixin_39630126/article/details/111520238)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

举儿

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值