Question

基本上，我想写一段既可以作为工作代码又可以作为文档的MarkDown（最好是GitHub风格）的文本。我使用的语言的C格式注释\\用于行尾，/* ... */用于多行注释。到目前为止，我能做的是：

/* --> start with multi line comments 
here some markdown text
# heading
 * list

end markdown section with
<!--- */ // -->
or
[//]: # (end of comment block --> */ // <-- inline comment)

_-_-indented code
_-_-_-_-more indented code

问题是：

第一个/*仍显示在文档中
我无法使用正确的多行代码块``` ... ```。我不得不缩进代码部分一次以上。同样，语法突出显示在此AFIK格式下不起作用。

如果您能帮助我首先了解如何解决上述问题，我将不胜感激。其次是否还有更好的方法呢？

Answer 1

我想我现在有一个可折叠/可折叠的代码段：

/*

This is the markdown **text** 

used for documentation

<details>
  <summary>Click to see the source code</summary>

``` scilab 
*/
This is the
  actual code
  which will 
be executed
/*
```

</details>

<!--- */ // -->

将呈现为：

/ *

这是减价文本

用于文档

*/
This is the
  actual code
  which will 
be executed
/*

可折叠部分确保文档整洁且可读。您可能会看到最终结果here on GitHub。我使用了here中的代码。现在有一堆/*和*/很适合搭车。下一步是按照我所问的here将MarkDown文档模块化为不同的文件。

P.S。。使用AsciiDoc here实现了相同的想法。

如何将Markdown文档嵌入使用C类型语法进行注释的工作代码中？

1 个答案: