1回答
我正在测试一些不同的文档引擎，我想为我们的大型项目尝试typedoc。我们在整个项目中都有各种测试文件(somefile.test.ts或someotherfile.test.tsx)。我正在努力让typedoc忽略这些文件。我做了npm i -D typedoc，然后在我的tsconfig.json
{
"compilerOptions": {
"configOptions": "some_options"
},
"include": ["src"],
"typedocOption
浏览 153提问于2021-03-02得票数 0
1回答
我有两个文件，文件A和文件B。文件A使用B文件中的一个类。我的目标是在文件A的TypeDoc输出中引用B文件中使用的类的TypeDoc输出。
我知道，您可以使用TypeDoc引用包含在同一个文件中的符号，并带有双括号，比如[[Foo]]，但是对于这样的外部类型，这是行不通的。
/** Trying to reference [[FileB.InnerClass]] like this doesn't work. */
// This here is what I want to include
export type InnerClass = FileB.InnerClass;
//
浏览 1提问于2019-07-25得票数 13
回答已采纳
1回答
我有一个TypeScript项目，我正在使用TypeDoc为它生成文档。在我的项目中，我使用了一个拥有自己现有文档的外部库。在我的项目的TypeDoc输出中，我希望将读者链接到外部库的文档，而不必手动插入URL。
我最接近的解决方案是在代码注释中用双括号括起我想要链接的内容，如下所示：
/** I want to link to something called [[Foo]] */
但这似乎不适用于外部库中的类型。
这有可能实现吗？
浏览 9提问于2019-08-01得票数 4
我试图使用TypeDoc为我正在开发的js应用程序生成文档。由于某些原因，我无法让TypeDoc输出任何东西--文件或错误。
为了达到这个目的，我在项目文件夹中安装了TypeDoc：
npm install typedoc --save-dev
然后，我在项目文件夹中的admin中打开了PowerShell (也尝试了cmd)，并尝试用几个变体运行TypeDoc，看看是否可以让它工作：
node typedoc --help抛出一个错误，说明找不到模块。
node node_modules/typedoc --help似乎正在运行，但不会产生任何输出。
node node_modu
浏览 0提问于2019-08-04得票数 0
回答已采纳
在Typedoc中，可以使用以下方法链接到另一个类：
[[ClassName]]
{@link ClassName}
这个类甚至可以属于另一个模块。
但是，我想不出如何链接到
另一个模块
从另一个模块导出的函数
因此，假设您有2个d.ts文件：
Foo.d.ts
/**
* I want to link to:
* the [[Bar]] module //does not work
* the {@link Bar} module //does not work
* the [[Bar.foobar]] function //does not work
浏览 10提问于2019-10-17得票数 4
回答已采纳
目标是从TypeScript代码中获取JSDoc文档。来自TypeDoc (TypeScript文档解决方案)的文档的质量是不可接受的，因为文档是针对JS用户的，不应该被特定于TypeScript实现(接口等)的细节所淹没。
目前，转换为ES6并从JS文件生成文档在很大程度上做到了这一点。没有赋值的属性除外。就像看起来的那样，
class A {
/**
* @private
* @var _a
*/
private _a;
/**
* @public
* @var a
*/
public a = t
浏览 1提问于2016-02-03得票数 12
type S=string|undefined;
declare global {
export interface String {
/**
* returns string between borders
* @param borderA - left border
* @param borderB - right border
* @param aIsFirst - true if borderA is first, false if is last
* @param
浏览 4提问于2021-06-01得票数 3
我是Node的新手，在这个package.json中，对于React项目，我理解rimraf做了什么，但是--tsconfig到底在做什么呢？
当我运行prebuild脚本时，我看到文件typedoc.json被删除。但为什么是这个--tsconfig？有一个tsconfig.json文件，但我看不出rimraf在做什么
"scripts": {
"build": "tsdx build --transpileOnly --entry ./src/index.js",
"prebuild": "npm ru
浏览 2提问于2021-10-12得票数 0
回答已采纳
1回答
我用typedoc风格编写了批注和解释，围绕着我的棱角项目。
然后运行以下命令来生成文档：
typedoc --name Sample Project --out ./docs/ --tsconfig ./tsconfig.json --exclude node_modules --ignoreCompilerErrors app/
但发生下列错误：
fs.js:1001
binding.stat(pathModule._makeLong(path), statValues);
^
Error: ENOENT: no such file or directory, s
浏览 0提问于2018-02-14得票数 1
回答已采纳
1回答
代码是：
/**
* Class description
*/
export class SomeClass {
/**
* The field description
*/
message: string;
}
我在上检查它，看到有类的摘要，但没有它的字段的摘要
有没有办法在typedoc中描述一个字段？
浏览 10提问于2021-02-12得票数 0
回答已采纳
1回答
我想为Intern4功能测试自动生成一些文档。我尝试了typedoc，在解析我的对象页面函数时，它工作得很好，但在功能测试套件上失败了，例如，在如下文件上
/**
* This is a test comment for general purpose
*/
/**
*
*/
const { registerSuite } = intern.getInterface('object');
const { url } = intern.getPlugin('conf');
import {
tryLogin,
pollForDElemen
浏览 3提问于2018-07-26得票数 0
我昨天刚开始使用Simulink。以下是我所做的:我将一个增益连接到一个Integrator，然后连接到一个零序保持，然后连接到一个工作区。我得到了增益k*u，其中k是我定义工作空间的标量。因此，链中的第一个元素是增益。这样可以吗？
问题是，当我运行程序时，我得到警告:警告：'test_simulink/Gain‘的输入端口1未连接。
为什么会有警告？我需要担心吗？据我所知，当子系统需要向更大的系统输入/输出/形成更大的系统时，就需要使用端口。因此，在这种情况下，端口似乎是不必要的。
那么为什么要发出警告呢？
浏览 0提问于2015-07-31得票数 0
1回答
每一个人一天中的美好时光，
我已经创建了一个吞咽任务，它应该创建tsdocs，下面是它的样子。
'use strict';
var gulp = require('gulp'),
helpers = require('../helpers/gulp-helpers')(),
plugins = require('gulp-load-plugins')(),
env = require('./gulp.env');
function typedoc() {
return gul
浏览 3提问于2016-03-31得票数 5
1回答
如何在类型记录中记录Union类型，以便typedoc能够提取/显示相关信息？下面是一个JSDoc引用，但是有TSDoc引用吗？
示例
/**
* Search parameters
* These comments are not picked up, I generate blank page
*/
export type SearchParams = string | string[][] | Record<string, string>;
/**
* Query parameters
* These comments are not picked up, I g
浏览 2提问于2021-01-28得票数 4
回答已采纳
1回答
我正在尝试在我们的Aurelia项目中使用TypeDoc来创建文档。不幸的是，我们无法生成任何输出，因为TypeDoc无法解析typescript文件中的模块导入。是否有人使用typedoc从Typescript/aurelia项目创建文档？有什么建议吗？
浏览 1提问于2017-03-24得票数 0
1回答
我正在尝试为TypeDoc运行gulp任务，但是我得到的每个ts文件都有这个错误
Experimental support for decorators is a feature that is subject to change in a future release. Specify '--experimentalDecorators' to remove this warning
我的gulp文件：
var gulp = require('gulp');
var typedoc = require("gulp-typedoc");
gu
浏览 2提问于2016-05-10得票数 0
1回答
对于一个项目，我必须模拟一个类，并且我想在我的代码中使用这个模拟来模拟一个行为。在我的Test类中，我放入了以下代码：
public function testExportCsv()
{
$mockObject = $this->getMockBuilder('\Client')
->setConstructorArgs(array("0"))
->getMock();
$res = $this->searchDocApiDocumentsStub();
$mockObject-&g
浏览 0提问于2017-05-15得票数 2
1回答
我必须自动化我的类型文档，以便我可以直接上传到汇合页面。我已经尝试过狮身人面像，但是typedoc不生成Sphinx需要的RST文件。
浏览 17提问于2022-08-23得票数 0
1回答
我安装了typedoc：
npm install typedoc --save-dev
然后将typedocOptions添加到tsconfig.json中：
{
"compileOnSave": false,
"compilerOptions": {
"baseUrl": "./",
// ...some lines there
"typeRoots": [
"node_modules/@types"
],
"lib":
浏览 35提问于2021-02-12得票数 2
回答已采纳
1回答
我有一个基于台风的反应应用程序。它工作得很好，但我想在混合中添加TypeDoc (考虑到类型记录的JSDoc )。在安装它之后，我从命令行运行它(只在测试时处理一个文件)：
typedoc --module commonjs --jsx react --out ../docs/ ./src/components/404/404.tsx
我得到了一个错误：
Error: /path/to/project/src/components/404/404.tsx(0)
Cannot find module 'react'.
反应是，事实上，安装了。我尝试过在全局和本地运行安装的Typ
浏览 4提问于2016-03-21得票数 6
回答已采纳
我使用swagger-ui-express模块为我的node js后端构建了一个swagger。我有一个返回文件( pdf-doc或xlsx)的端点。当我在swagger上测试我的端点时，它返回200响应，并在body上始终显示此消息‘无法识别响应类型；将内容显示为文本。’这是我的swagger端点的代码。
"/reports?typeDoc={typeDoc}&file={file}": {
"get": {
"tags": [
浏览 2提问于2019-06-06得票数 5
5回答
我有一个非常简单的select定义，如下所示：
<select name='typedoc' id ='typedoc' size=1>
<option>1</option>
<option>2</option>
</select>
有两个值，1和2。显示器正常。我不能用jQuery来改变这个值。我试过了：
$('[name=typedoc]').val('2');
和
$('#typedoc').val('2'
浏览 0提问于2012-02-21得票数 1
1回答
我使用的是NPM版本的6.12.1。当我在项目文件夹中的Windows控制台中输入以下命令时：
npm install
我得到了这个输出：
npm警告typedoc@1.4.1需要一个typedoc@^0.4.1的对等点，但没有安装任何类型。您必须自己安装对等依赖项。
但这条命令：
npx typedoc -v
产出如下：
TypeDoc 0.15.3
因此，在我看来，这种依赖似乎得到了满足。信息不应该在那里。
我已经在googled上找到了一些线程，其中人们报告了类似的问题，这是由NPM中的一个bug引起的。然而，这些线索已经有好几年了。我是不是漏掉了什么，还是这还是个窃听器？
浏览 3提问于2019-11-27得票数 0
回答已采纳
1回答
有没有地方可以得到OMF对象格式的Windows预编译的BLAS和LAPACK二进制文件？我想将一些D语言代码链接到这些代码。我知道在哪里可以买到。我也知道objconv工具，它将COFF转换为OMF，尽管由于我不完全理解的原因，这在实践中似乎不起作用。这些似乎与符号中的下划线有关，尽管我尝试了几乎所有处理这些设置的设置，但似乎都不起作用。
或者，有没有人知道如何转换，以便它们能够正确地链接到DMD编译的代码？作为最后的手段，有谁知道如何使用DMC构建CLAPACK、CBLAS和F2CLIB？随之而来的构建过程似乎完全是针对GCC工具链的。
浏览 23提问于2011-02-11得票数 10
3回答
我有一个带有复选框列表的表单，这些复选框的输入名是typedoc_1、typedoc_2、typedoc_3等。我如何做一个循环来检查哪些数字被检查了？通常我在我的控制器中使用Request (as $request->type_1)。谢谢。
浏览 0提问于2018-01-20得票数 0
当我使用typedoc生成文档时，它只为导出的函数和变量生成文档，即使我将excludeNotExported设置为false
这里是我在tsconfig.json的typedocOptions
"typedocOptions": {
"mode": "modules",
"out": "docs/td",
"excludeNotExported":false,
}
浏览 1提问于2020-01-20得票数 1
我在Linux上开发了多年的项目。它依赖于MKL、libxml++、GSL和armadillo库。
它的安装结构是在CMake中完成的，项目是通过构建一个共享库和几个链接到它的可执行文件来形成的。图书馆里大约有20节课。
项目结构是：
--src
--executable1.cpp
--executable2.cpp
--mysharedlib
--class1.h
--class1.cpp
--...
我的问题是如何在Windows中的Visual中安装和运行此代码。我以前从来没有用过VS，现在还在学习教程。我通过在WSL上安装Ubuntu来运行我的代码，
浏览 7提问于2022-08-10得票数 0
回答已采纳
我正在我的一个项目中使用Deno，我想用typedoc生成文档。我面临着很多依赖关系的问题，因为它们没有得到正确的解决，所以typedoc失败了。我有以下tsconfig.json {
"compilerOptions": {
"module": "amd",
"target": "esnext",
"baseUrl": ".",
"paths": {
"http://*": ["../../.
浏览 58提问于2020-10-14得票数 0
看起来在Elixir中有三种类型的文档(v1.1.1是我现在使用的版本)、@doc、@moduledoc和@typedoc。
在iex中，@doc和@moduledoc可以由h/1打印出来，但不能用@typedoc打印。我知道t/1可以打印类型定义，但我需要文档。
h/1只支持@doc和@moduledoc的任何原因
浏览 0提问于2015-10-04得票数 3
回答已采纳
1回答
我正在开发“每个用户一个数据库”系统，使用带有选择器的CouchDB replication来根据用户配置过滤数据。
它运行得很好，直到我注意到复制问题的那天，我很难描述它，所以我将用一个例子来描述它：
我有我的主数据库"mainDB“，我正在使用它作为复制的"source”数据库，并且我决定为一个用户创建一个子数据库"subDB“，它将成为复制的”目标“。
我用选择器创建复制文档来过滤"mainDB“中的数据，没有发生任何事情，我的"subDB”是空的，复制状态标记为"Running“，但是0挂起changes。
一旦我从"mainDB
浏览 13提问于2022-10-19得票数 1
我以为这是一个非常简单的任务，但我没有发现任何相关的或我的错误。所以把我的问题放在这里，我有一些MSP430的项目，实际上是在代码编写工作室中。现在我必须将整个代码运行到IAR嵌入式工作台中。项目中还提供了一些库文件(*.lib)，这些文件必须链接才能构建项目。经过一些修改后，代码编译得很好，但我无法链接库和获取链接器错误。我用avr做过IAR，但是很少测试一些样本代码。我没有找到在哪里提及这些库名及其各自路径的选项。我检查了链接器选项卡，但我不知道如何将这些.lib文件链接到项目中。
浏览 1提问于2012-03-23得票数 2
2回答
我是TypeScript的新手，我有一些现有的TypeScript项目。
为了更好地理解这个项目，我尝试使用TypeDoc。
然而，我得到了跟随错误。
我试图在之后解决这个问题，但没有成功。
有人能告诉我解决这个问题的方法是什么吗？
internal/modules/cjs/loader.js:1032
throw err;
^
Error: Cannot find module 'typescript'
Require stack:
- /usr/local/lib/node_modules/typedoc/dist/lib/cli.js
- /usr/local/
浏览 9提问于2020-06-23得票数 1
1回答
我正在尝试使用typedoc include，所以我是这样做的。
// ./src/store/index.ts
/**
* [[include:TypeScriptReactReduxTutorial.md]]
*/
import { combineReducers } from 'redux'
import { counterReducer } from './counter/reducer'
import { IApplicationState } from './types'
/**
* Whenever an acti
浏览 1提问于2018-08-07得票数 2
我目前正在探索TypeScript，我想知道为什么不将整个应用程序编译成一个单独的JS文件，而不是将每个.ts文件编译成对应的.js。
这样一个应用程序的例子是TypeDoc，它基本上编译成一个bin/typedoc.js文件。
常见的概念是将每个.ts文件编译到一个.js文件中，并使用--module commonjs作为类型记录编译器的参数。
如果我构建一个编译成单个文件的可伸缩(大型) web应用程序，我需要担心什么吗？
浏览 0提问于2015-05-18得票数 2
1回答
我有一个Document.xib和一个MainMenu.xib，还有一个类MainController。通过将对象库中的MainController拖到Document.xib的实例树并将属性中的类设置为MainController，我向Document.xib添加了一个NSObject实例。我添加了一个按钮，并将其连接到MainController提供的操作之一。
到目前为止一切都很清楚。现在，我基本上想从菜单项调用相同的操作。显然，我不能仅仅将MainController的另一个实例添加到MainMenu.xib中，因为我最终会得到两个实例。每个文档应该只有一个，菜单项应该调用活动文档的M
浏览 1提问于2013-07-24得票数 1
回答已采纳
1回答
钩子性质绑定
、、
我试图将ImageUrl属性连接到MvxImageView，以实现自己的图像缓存服务。
我试过使用获取值的PropertyConverter，但没有收到响应。
然后，我尝试了我自己的IMvxImageHelper实现，但是我得到了一种不寻常的行为，因为我使用带有图像的列表，所有图像容器都得到相同的图片，当我滑动列表时，所有MvxImageView小部件中的图片都会发生变化。
此实现在使用CreateApp方法的RegisterSingleton中的安装文件中。
什么是连接到缓存图像过程的正确方法？
浏览 3提问于2013-10-31得票数 0
回答已采纳
1回答
我正试图用TypeScript为我的TypeDoc项目生成文档。这一代可以工作，但我无法找到如何将类组织成模块，并让TypeDoc将它们显示为模块。
目前，我的类只是按目录组织的，但是TypeDoc似乎没有意识到这一点(一切都是全局的)。我认为应该有另一种方法来定义模块，但我找不到方法。
有人有这方面的经验吗？谢谢!
这就是我目前的情况：
这就是我想得到的：
浏览 0提问于2016-05-18得票数 5
0回答
模板JS文档生成器
、、、、
我正在使用模板JS创建自定义web组件。在某一时刻，我遇到了为创建的自定义web组件生成文档的需求。我尝试生成的文档很少，比如typedoc和docsify。Typedoc似乎是一个很好的选择，但它会生成静态网站。在我的需求中，我更喜欢让用户动态更改代码的值，并在使用它之前预览它。为此，我找到了CodeMirror。有没有一种方法可以将CodeMirror与TypeDoc集成，让用户编辑实时代码并查看web组件中的更改。
如果有任何其他插件或生成器可以做这项工作，请建议。
谢谢
浏览 17提问于2018-07-05得票数 1
我有一个JS项目，我在一个单独的目录中手动定义类型声明文件。以前，我使用的是typedocv0.19.2，它使用这个typedoc配置生成了漂亮的文档：
{
"out": "docs",
"excludeExternals": true,
"includeDeclarations": true,
"mode": "file"
}
我的类型声明文件主要将类型信息添加到全局范围，例如：
declare global {
namespace something {
...
浏览 7提问于2022-01-20得票数 2
回答已采纳
1回答
我有关于TypeDoc的下一个问题。所以我有一个这样的TypeDoc配置：
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../MyDocumentation/',
name: 'MyApp',
target: 'es5',
exclude: '**/*/*.d.ts',
exclu
浏览 0提问于2018-08-23得票数 3
回答已采纳
我是一个使用Typedoc的新手，我遇到了一个抛出的错误。
当我在我的项目中运行Typedoc时，文档被正确地生成，但我也得到了一个错误：
$ ./node_modules/.bin/typedoc --mode file --module commonjs --out ./docs/typescript --target es5 src/ Error: Could not parse /home/michael/workspace/test/node_modules/paralleljs/package.json
我不明白为什么Typedoc会查看node_modules/，而我指定在src
浏览 0提问于2018-10-23得票数 0
我尝试过 TypeDoc不为本地文件生成文档。我使用了命令：yarn typedoc和tsconfig.json，下面是其中的一部分
"typedocOptions": {
"entryPoints": ["src/main.ts"],
"out": "docs"
}
-entryPointStrategy没有任何价值。
浏览 15提问于2021-12-09得票数 2
2回答
为.jsx和.tsx文件中的React钩子生成文档的最佳方式是什么？ 我尝试了TypeDoc，但是我没有从函数方法中得到任何注释。 const MainFunction = () => {
/**
* How to get generate this comment?
*
* @param a first number
* @param b second number
*
* @returns sum of and b
*/
const sumNumbers = (a, b) => {
return a + b;
浏览 15提问于2020-03-27得票数 3
回答已采纳
我使用typedoc和npm脚本( )来安装npm run d，用于：
"d": "typedoc --out doc --exclude **/*.spec.ts ./projects/fs-is/src/lib"
我将项目升级到了角12 (它使用了角包格式)，现在在运行typedoc时，它包含了来自node_modules的文件，并失败了：
Error: node_modules/@types/eslint/index.d.ts:474:43 - error TS2694: Namespace '"/Users/oleersoy/Githu
浏览 6提问于2021-09-28得票数 0
回答已采纳
1回答
我需要为我的测试编写文档注释，然后在HTML文件中生成文档。我使用typedoc成功地生成了文档，但只为我的类和方法生成了文档，而不是为我的测试生成文档。我的问题是:我如何为我的测试编写文档注释？
在我的测试中，我使用了testcafe。我总是成功地生成报告。
/** *测试license02 */ <--不生成此块注释
测试(‘LICENSE-02’，异步=> {
..。
})；
我需要为我的测试生成文档注释，但目前只记录了方法和类。
感谢您的帮助！
浏览 6提问于2019-09-11得票数 1
TypeDoc不理解TypeScript静态块。静态块被添加到TypeScript 4.4中。我使用的是TypeDoc 0.22.17，它声称支持TypeScript Version4.0到4.7
为了让TypeDoc理解TypeScript中的静态块，还有什么需要做的吗？
例如，这里是文件"src/hello.js"：
/**
* My class
*/
export class HelloWorld {
constructor() {
console.log("Hello World");
}
static
浏览 10提问于2022-06-14得票数 0
回答已采纳
2回答
我在用咕噜和打字机做应用程序。
我需要使用TypeDoc编写文档，但有一个方案有问题。
我必须从文档中排除一些文件，这些文件是外部文件库。我不能将这些文件放入exclude部分，因为这些文件与另一个文件有关。如果我试图排除它(通过将这些文件放入exclude部分)，我就出现了一个错误--类似于cannot find to xxx into yyy.ts --其中xxx是我排除的元素，yyy是与xxx相关的文件。这些相关的文件在这个文档中是必要的，所以我也不能排除这些文件。
我阅读了TypeDoc关于的文档。所以我想，如果我把这个布尔值设置为true，那么我就可以定义externalPatter
浏览 0提问于2018-08-20得票数 1
回答已采纳
我有一个简单的基于文档的Cocoa应用程序，它充当.wav文件的查看器，进行一些频率分析。我希望能够将从打开的文件中收集的数据导出到CSV中，以便在其他程序中进一步分析。
Cocoa中基于文档的应用程序框架允许您重写
- (NSData *)dataOfType:(NSString *)typeName error:(NSError **)outError
要实现默认的保存/另存为...工作流，但我不想写我打开的文件。
最明显的做法是在我的文档中实现导出工作流，提供一个文件保存表，构建一些NSData，并将其写入文件路径，但是没有一种明显的方法可以将MainMenu nib中的出口连接到文档控
浏览 1提问于2009-04-20得票数 3
回答已采纳
1回答
我正在尝试使用typedoc生成文档。我的打字本文件中有以下几行。
var validator: any = require('validator');
import * as _ from 'lodash';
var mqtt: any = require('mqtt');
var fs = require('fs');
var path = require('path');
var tls = require('tls');
import * as collections from 't
浏览 6提问于2016-06-01得票数 4
回答已采纳
1回答
TypeDoc创建空文档
、、、、
我有一个gulp任务，它应该获取我的文件并为它们创建文档。该任务如下所示：
var gulp = require('gulp');
var gulptypedoc = require('gulp-typedoc');
gulp.task('typedoc-gamesmart', function () {
return gulp.src([
'./src/util/Config.ts',
'./src/util/Http.ts',
'./typing
浏览 14提问于2016-09-07得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
