标签: documentation

众所周知，如何在 Doxygen 中获取 TODO 列表，输入：

\todo Item one
\todo Item two

等等，但是当某件事完成后，如何跟踪呢？

如果我已经完成了第二项，我不想删除它，我想将其标记为已完成：

\todo Item ono
\done Item two

我该怎么做呢？

可以在 PowerShell 中定义脚本的输出类型。考虑myScript.ps1：

[OutputType([String])]
param(
    [string]$name
)

以下返回String：

(Get-Command .\myScript.ps1).OutputType.Name

但我想指定脚本返回text/json或text/xml. 这样做的好方法是什么？

为 OutputType 发明类型（例如[String.JSON]）不起作用。

我正在使用 Compo-doc 来记录我的 Angular 2 应用程序。在我的应用程序的目录结构中成功创建文档文件夹后，当我尝试通过命令访问浏览器上的文档时，默认情况下它会在“localhost:8080”端口上打开。我们已经将 8080 端口用于微服务。所以我需要更改文档渲染的端口。任何人都可以帮我解决这个问题吗？

虽然这有效

1. [Notifier system requirements](#requirements)

这不起作用

1. [Deployment steps](#steps to deployment)

Steps to deployment和requirements是我的文件中的标题/部分标题README.md。

当给定范围 -1 和 1 之间的指数参数时，torch.pow() 返回 nan

a = torch.randn(1,3)
a

>> tensor([[-1.7871, -0.5375, -0.1164]])

torch.pow(a, 2)      #or a**2

>> tensor([[3.1938, 0.2889, 0.0136]])

torch.pow(a,0.5)     #or a**0.5

>> tensor([[nan, nan, nan]])

期望结果：

tensor([[-1.3368, -0.7331, -0.3412]])

编辑：事实证明 ** 也以同样的方式工作。a**2对张量执行与 相同的操作torch.pow(a,2)。 a**0.5像 torch.pow 一样返回 nan 。

我有一个功能factory：

function factory(events) {
  for(const key in events) {
    const { before, after } = events[key]
  }
}

参数events通常是：

{
  only: {
    before(){}
    after(){}
  },
  except: {
    before(){}
    after(){}
  },
}

其中键only,except可以是任何内容，但值始终（必须是）类型，{before, after}其中before,after都是函数。

如何使用 JSDoc 记录函数events中参数的结构factory？

我能想到的唯一解决方案是创建events一个数组，然后我可以typedef像这样使用：

/**
 * @typedef event
 * @property {function} before
 * @property {function} after
 */
/**
 * @typedef eventTuple
 * @property {string} key …

编辑：韦兰的回答成功了！谢谢！

我正在尝试压缩 .html 文档文件以发送给客户。目标是获得与浏览实际网站相同的体验。

打开 .html 文件时，单击的任何链接都会转到父文件夹，而不是特定的 .html。例如，如果我单击配置页面的链接，它会将我带到此父文件夹（如图所示），其中包含指向实际页面的 index.html。这仅在我浏览 .html 文件时发生在我的本地实例中，而不是在我导航构建的 .md（使用 MkDocs）时发生。

• macOS Catalina，10.15.3
• MK文档
• 降价

我正在使用 eslint 来设置我的 Node js 项目，但我不断收到以下警告：

现在，在我的 .eslint.json 中，我无法找到规则/技术来帮助忽略这些新标签和类型。我查看了以下文档： https://eslint.org/docs/rules/

你好，我正在为 api 创建 swagger 文档，我想添加 xml 示例，但我做不到。

这是我写的 swagger 文档

swagger: "2.0"
info:
  title: Documentatie API 
  description: Descriere documentatie API metode POST
  version: 1.0.0
host: xxx.ro
basePath: /v1
schemes:
  - https
paths:
  /stareMesaj:
    post:
      summary: Stare mesaj
      description: Descriere stare mesaj
      consumes:

            - application/xml
      produces:

            - application/xml
      responses:
        200:
          description: OK
          schema:
            type: object
            properties:
              id:
                type: integer
                example: 4
              name:
                type: string
                example: Arthur Dent

我认为模式下的属性会在示例中发生变化，但它说：

<?xml version="1.0" encoding="UTF-8"?>
<!-- XML example cannot be generated; root element name is …

'''Python

from django.urls import re_path
from . import consumers
websocket_urlpatterns = [
    re_path(r'ws/chat/(?P<room_name>\w+)/$',consumers.ChatConsumer.as_asgi()),]

获取 as_asgi() 错误