Orleans 2.0 官方文档 —— 9.3 资源 -> 文档指南

最新推荐文章于 2019-04-05 06:51:09 发布

闫辉_13510215218

最新推荐文章于 2019-04-05 06:51:09 发布

阅读量420

点赞数

分类专栏： Orleans

91 篇文章 5 订阅

订阅专栏

文档指南

Orleans文档是在Markdown中构建的。我们使用一些简单的约定，来确保整个文档集中的风格是一致的。

这些标准正在被引入。如果您对这些指南有疑问，请提出问题或拉取请求。如果您发现文档不符合指导原则，请进行修复，并提交一个拉取请求。此外，如果您使用的是Windows 10，您可以去应用商店找到例如这样免费的MarkDown编辑器。

文档遵循美国英语的拼写。http://markdownpad.com和Visual Studio Code等桌面工具，具有拼写检查功能。

每个句子应该写在一行上，每行只有一个句子。这使得合并更改更容易，并有助于识别冗长的语言。Markdown中的段落只是一行或多行连续文本，其后跟着一个或多个空行。

应使用header来构造文档。避免使用全大写、斜体或粗体等其他强调功能来标识新主题。使用header不仅更加一致，而且还允许链接到header。

在页面的末尾，链接到文档中的下一个逻辑页面会很有帮助。如果页面是子节中的最后一页，则链接回索引页面很有用。

应使用三个反引号（即```），然后跟着代码，来格式化示例代码块。

    [StorageProvider(ProviderName="store1")]
    public class MyGrain<IMyGrainState>
    {
      ...
    }

这将呈现为


[StorageProvider(ProviderName="store1")]
public class MyGrain<IMyGrainState> ...
{
  ...
}

内联的代码应标有一个反引号（`）。

这包括引用到：

如果显示的文本是一个输出（例如文本文件内容或控制台输出），您要么使用三个反引号而不指定语言，要么缩进内容。例如：

1 said: Welcome to my team!
0 said: Thanks!
1 said: Thanks!
0 said: Thanks!

引用文件名、目录/文件夹或URI时，请使用标准斜体进行格式化。这可以通过使用单个星号（*）或单个下划线（_）包围字符串来完成。

例子：

Markdown支持表格数据。表格可用于结构化数据，因此读者很容易理解。

在引用另一个概念时，请提供该概念的链接。页面中的前向和后向引用，可以通过标题链接。例如，链回到其他文档结构的链接，可以链接到页面，或者链接到该页面内的子节/标题。外部链接应作为完整链接公开。例如https://github.com/dotnet/roslyn

Orleans文档承载在Git库中的GitHub上的gh-pages分支中，它作为Markdown文件进行托管。有关如何使用“项目站点”文档的gh-pages分支的约定，请参阅GitHub Pages文档。

关注