标签: code-documentation

我为我的问题的简单性道歉,但我试图使用Appledocs生成文档(https://github.com/tomaz/appledoc#quick-install)

我不确定如何设置它.我这样做的方式是:

• 我克隆了github repo,然后在终端中使用安装脚本(我使用appledocs --help确认这个)安装appledocs .

但是,现在我如何实际使用这个,因为我在xcode中有我的项目:

• 如何生成文档文件
• 它在哪里生成？

我是 Powershell 的新手，据我所知，它没有像 Python 中的 PEP8/PEP484 这样的东西。我从 Microsoft找到了这份文档，并从 Posh Code 找到了这份第三方指南。我写了以下函数：

function Invoke-Authenticate {

  [CmdletBinding()]
  param (
      [Parameter(Mandatory)]
      [string] 
      # IP address of the OME server
      $Ip,

      [Parameter(Mandatory)]
      # Credentials for the OME server
      [pscredential] $Credentials
  )

  $SessionUrl  = "https://$($IpAddress)/api/SessionService/Sessions"
  $Type        = "application/json"
  $UserDetails = @{"UserName"=$Credentials.username;"Password"=$Credentials.GetNetworkCredential().password;
                   "SessionType"="API"} | ConvertTo-Json
  $Headers     = @{}

  try {
    $SessResponse = Invoke-WebRequest -Uri $SessionUrl -Method Post -Body $UserDetails -ContentType $Type `
                                      -SkipCertificateCheck
    if ($SessResponse.StatusCode -eq 200 -or $SessResponse.StatusCode -eq 201) {
      # …

Julia是否有任何内置工具可以从源代码生成文档？有点像doxygen吗？

我找不到任何原生支持的东西,如果事实确实存在或有人可以推荐外部应用程序,我很好奇.

我是PyCharm和其他Jetbrains IDE的"快速文档"功能的粉丝,但它需要知道每个库的特定"文档URL",它们在设置下Preferences > Tools > Python External Documentation设置.

我想知道是否有人为以下任何库工作:

• Tensorflow
• PyTorch
• Matplotlib
• Seaborn
• 熊猫

在Xcode中使用Swift或Objective-C时,Xcode在Utilities部分提供了一个Quick Help工具,并通过选项单击代码中的内容.这样你就可以看到一些关于你点击的东西的文档.

有没有办法使这也适用于C++？(或者是另一个做类似事情的IDE,我并没有真正受限于Xcode.)

[Option键]

[快速求助]

谢谢!

我曾经像这样引用 Java Doc 中的方法：

/**
 * @see com.myapp.view.fragment.PlaybackControlFragment#onPlaybackStateChanged
 */

我不知道如何在 kotlin 中引用相同的方法？

该部分com.myapp.view.fragment.PlaybackControlFragment已链接，但方法名称不可点击和链接。

什么是正确的语法？

我正在努力寻找文档（或通过代码试验获得的结果）将布尔值作为 material-ui 中网格组件的断点道具的值的目的是什么。查阅grid api 文档显示布尔值是断点道具 lg、md、sm、xl、xs 的有效值。

我明白，如果我说sm={3}我会得到一个组件，一旦显示宽度增加到超过 xs 断点（600px），它就会改变以占用 3 个网格列单位，但不知道将布尔值作为值传递：

例如，提供xs={true}或md={false}成为的原因是什么？我怎么可能自己知道原因？（是否有一些我缺乏的基础知识？）

我已经使用相关文档定义了以下类型特征结构：

/*!
 * @brief Get the type at a given index Idx from a template parameter pack TPack. 
 *
 * Provides a member type holding the type at a given index Idx in a template
 * parameter pack TPack. 
 * <br> The index must be less than the template parameter pack dimension, otherwise
 * a compilation error will be triggered.
 *
 * @ingroup my_group
 */
template <unsigned int Idx, class... TPack>
struct TypeAt;

然后提供了一个方便的别名（在同一个文件和同一个命名空间中定义）为：

/*!
 * @ingroup my_group 
 */
template<unsigned …

我有一个用 ASCIIDOC 编写的带有可编辑 PNG 的项目文档，我想在我的文档中创建一个链接，直接在 draw.io (diagrams.net) 中打开本地文件。

类似于https://app.diagrams.net/file=/home/alex/test.png。或https://app.diagrams.net/data={PNG的十六进制数据}

我的第一站是文档： https: //www.diagrams.net/doc/faq/supported-url-parameters 但我不知道如何转换数据参数的可编辑 PNG，也不知道如何指示应用程序自动打开上传对话框。

任何意见是极大的赞赏。

我最近发现可以在 Javadoc 中对同一个异常使用多个@throws标签。

我的一位学生用它来记录他在《四子棋》中的一种方法：

/*
 * ...
 * @throws IllegalArgumentException if the number of rows or columns is invalid 
 * @throws IllegalArgumentException if one of the players has {@link Stone#None} as stone
 * @throws IllegalStateException if both players use the same stone color
 */
public void doSomething(...) { ... }

现在我（和他）的问题是：对于是否使用单个@throws标签或“是否可以”为每个异常类型使用多个标签，是否有官方风格指南或一般建议？