Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.19 KB

create-notes-tips-markdown.md

File metadata and controls

42 lines (24 loc) · 2.19 KB

#Notes and tips

在文档中可以使用4中不同的备注以提示或者警示文档的阅读者。

  • NOTE
  • WARNING
  • TIP
  • IMPORTANT

##用法 一般在文档中不使用备注信息。当需要使用的时候,一定要选择正确类型的备注形式:

  • NOTE 的信息一般是中性或者积极情感的信息,用于补充或者强调正文内容。NOTE 内的信息应该是补充性质的,不能取代正文信息。如果忽略该部分内容,应该不影响文档内容的完整性。

Note:

首先使用加粗字体的类型加半角的冒号表明该备注的类型,然后保留一个空行,之后是备注的主要内容。

  • WARNING 的信息是用于警示文档的读者这里有个特殊情况可能会造成问题,情感偏负面。文档的读者不能忽略该区域的内容。

Warning:

首先使用加粗字体的类型加半角的冒号表明该备注的类型,然后保留一个空行,之后是备注的主要内容。

  • TIP 内的信息是一些额外的帮助信息,或者是文档正文描述的方法或者步骤的替代方法。该部分的内容作为次要的补充内容,允许读者完全忽略。

Tip:

首先使用加粗字体的类型加半角的冒号表明该备注的类型,然后保留一个空行,之后是备注的主要内容。

  • IMPORTANT 提供文档的读者必需知道的信息。并且该部分信息不是该文档所要讲述的内容。但是该部分信息对于读者使用该文档是不可缺少的。文档的读者不能忽略该部分内容。

Important:

首先使用加粗字体的类型加半角的冒号表明该备注的类型,然后保留一个空行,之后是备注的主要内容。

虽然备注信息里可以添加图片、列表、链接、代码片段,甚至可以嵌套备注信息。但是在文档中要尽量保持备注信息简单清晰。如果你发现你正在编写一个格式非常复杂的备注信息,说明你需要为该文档创建额外的一个段落来承载这些内容。过多的备注信息会使得文档难以浏览和阅读。

##More resources