有没有一个程序可以让你写“漂亮”的图书馆教程？

Question

我需要为我写的库编写教程。该教程还应包括代码。 我想知道是否有一个平台/应用程序为编写带代码的教程提供了一个很好的选择？

Answer 1

我建议用Markdown语法编写文档，然后在Github上发布文件。

Answer 2

Sandcastle可能会有所帮助（它会从XML代码注释中生成文档文件（假设您的库所编写的语言支持这一点））。虽然我将输出描述为功能而不是漂亮。

Answer 3

这很大程度上取决于您计划发布教程的位置和格式。对于在线出版（即在网站上，如HTML / CSS），您可以使用syntax highlighter。