SQL 的重构文本？

发布于 2024-10-20 12:58:16 字数 478 浏览 1 评论 0原文

我正在尝试使用 DocUtils 和 reStructuredText 来注释 SQL 代码。当我将标记包含在多行注释中时，我可以让它工作。然后我使用 --Some text:: 来介绍每个代码块。

我无法使内部超链接发挥作用。我想写 -- .. 步骤1_：但由于主要注释，解析器会忽略这一点。使用多线样式也会失败。有办法让它发挥作用吗？

这是一个例子：

/*
==========
this query
==========
:Author: Me

Outline
==========

- Create table 1

- Create table 2

- Output the result

*/

-- _Step1: build the table::

    create table table1

-- _Step2: use Step1_ to build table 2::

    create table table2

原文

I am trying to use DocUtils and reStructuredText to comment SQL code. I can get this to work when I include the markup inside multi-line comments. I then use --Some text:: to introduce each block of code.

I cannot get internal hyperlinks to work. I would like to write
-- .. Step1_:
but the parser ignores this because of the leading comment. Using a multi-line style also fails. Is there a way to get this to work?

Here's an example:

/*
==========
this query
==========
:Author: Me

Outline
==========

- Create table 1

- Create table 2

- Output the result

*/

-- _Step1: build the table::

    create table table1

-- _Step2: use Step1_ to build table 2::

    create table table2

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

没有心的人 2024-10-27 12:58:16

我使用 Sphinx 来重组文本。例如，内部超链接的语法是：

.. step1:

.. code-block:: sql

   create table table1     

This is later text in which an internal hyperlink occurs. Note
the indention of create table table1. It is part
of the .. code-block:: sql directive, so it must be indented.
Now here comes the internal link. Please see :ref:`step1` as
to how to create the table.

I use Sphinx for restructure text. The syntax for internal hyperlinks would be, for example,

.. step1:

.. code-block:: sql

   create table table1     

This is later text in which an internal hyperlink occurs. Note
the indention of create table table1. It is part
of the .. code-block:: sql directive, so it must be indented.
Now here comes the internal link. Please see :ref:`step1` as
to how to create the table.

回复收藏 0 原文