腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
JSDoc
-
有
可能
制作
一个
集成
的
html
文档
吗
?
javascript
、
documentation
、
jsdoc
我用
JSDoc
制作
了我
的
Javascript API
文档
。在创建它们之后,./docs目录生成了我
制作
良好
的
JSDoc
文档
所在
的
位置。但我认为,每个.js文件都有太多不同
的
文件,如图标、脚本、样式、
html
文件……等。有没有什么简单美观
的
方法可以把这些文件变成像Redoc这样
的
集成
html
文件,这是最好
的</e
浏览 16
提问于2020-08-28
得票数 0
回答已采纳
1
回答
在reStructuredText中插入相对链接
documentation
、
restructuredtext
、
jsdoc
我正在记录
一个
包含Python组件和JavaScript组件
的
库。整个用户
文档
和Python API
文档
都是用reStructuredText编写
的
,使用Sphinx进行处理。工具包API在
jsdoc
中,使用
jsdoc
- JavaScript进行处理。主要
的
输出格式将是
HTML
。我是reST、Sphinx和
jsdoc
的
新手。我已经设置了
一个
构建系统,这样所有生成
的
浏览 3
提问于2010-09-03
得票数 37
回答已采纳
2
回答
如何使用
jsdoc
记录javascript单元测试文件?
reactjs
、
jestjs
、
jsdoc
我
有
一个
react项目,我正在使用jest编写单元和
集成
测试。我想使用
jsdoc
来记录这些文件。 但不知道怎么做?在
jsdoc
页面上什么都没找到。如果
可能
的话有人能帮我举个例子
吗
。
浏览 0
提问于2019-01-18
得票数 2
4
回答
具有轻量级标记
的
Javascript API
文档
框架
javascript
、
markdown
、
python-sphinx
、
restructuredtext
、
jsdoc
我正在寻找
一个
Javascript API
文档
框架,具有类似于
JSDoc
的
功能,但会在代码注释(而不是
html
)中使用易于键入
的
重构文本或标记。 额外好处:可以很好地与Sphinx
集成
。但是,我不想维护单独
的
文档
,而是从注释生成API
文档
。
浏览 0
提问于2011-08-12
得票数 5
回答已采纳
1
回答
PHPStorm/WebStorm:如何在快速
文档
中忽略JS库
phpstorm
、
webstorm
如何将PHPStorm/Webstorm
的
集成
快速
文档
设置为忽略特定
的
库/文件?此外,两个库
可能
定义了相同
的
类,并且至少能够指定应该在快速
文档
列表中隐藏哪个库,这将
浏览 0
提问于2011-08-29
得票数 3
回答已采纳
1
回答
@scope在sproutcore中
的
含义
javascript
、
sproutcore
我正在使用sproutcore,并且我使用sc-gen来生成这样
的
控制器(这来自sproutcore Todos教程):在生成
的
javascript文件中,我找到以下javascript注释行:我想知道这个@scope是做什么
的
。这是特定于sproutcore
的
东西,还是通常在javascrip
浏览 4
提问于2011-02-14
得票数 1
回答已采纳
1
回答
JSDoc
教程包括源文件
javascript
、
jsdoc3
我
有
一个
用JavaScript编写
的
JSDoc
3项目,我正在添加教程(用
JSDoc
3编写)。我
的
项目中有示例代码,由用户可以运行
的
一系列脚本组成,我基本上是在编写教程来解释每个示例脚本
的
功能。我希望在每个教程
的
顶部
有
一个
解释性文本
的
简介,然后包括
一个
示例脚本。我可以将示例代码复制并粘贴到教程文件中,并使其格式化正确,但理想情况下,我希望将该文件包括在内,这样我就不
浏览 0
提问于2017-01-05
得票数 0
2
回答
将@property设为私有
javascript
、
documentation
、
jsdoc
我正在使用 我希望能够生成两次
文档
,一次列出私有属性,另一次不列出私有属性。
浏览 8
提问于2013-05-08
得票数 1
2
回答
限制对Firebase宿主内容
的
访问
node.js
、
firebase
、
express
、
google-cloud-functions
、
firebase-hosting
我使用swagger (用于“外部”
文档
)和
jsdoc
(用于“内部”
文档
)生成了
文档
。因此,从
jsdoc
,我
有
一堆
HTML
页面,我想要部署到FB主机上,但我只想限制对这些页面的访问,仅限于一些经过身份验证
的
用户。 swaggerUi.setup(swaggerSpec)exports.docs = functions.ht
浏览 5
提问于2021-05-11
得票数 2
回答已采纳
1
回答
如何更改默认
的
JSDoc
文本颜色?
javascript
、
gulp
、
jsdoc
、
jsdoc3
、
jsdoc2md
我正在使用
JSDoc
为我
的
JS库生成
文档
。由
JSDoc
生成
的
默认
HTML
内容
有
灰色文本,很难阅读。现在,我想把文字颜色改为黑色/蓝色。
有
什么方法可以改变文字颜色或背景颜色
吗
?
浏览 17
提问于2017-05-23
得票数 2
2
回答
在
文档
库中,是否可以在由
文档
中
的
标题创建
的
锚中保留大写?
docusaurus
我正在使用
文档
库为开源库
的
API发布
文档
。我
的
源文件
的
标题对应于库中类
的
方法和属性
的
名称。一切都很好。###.doSomething()<h3> <a aria-hidden="true" tabindex=&qu
浏览 0
提问于2021-10-11
得票数 0
回答已采纳
1
回答
动态地将内容注入
JSDoc
@示例
jsdoc
我使用
JSDoc
来记录我
的
javascript。 我
有
一个
@example,在这里我展示了
一个
最小化加载程序脚本(类似于Google脚本)。我
的
JSDoc
文档
与myProduct捆绑在一起,因此/myProduct/lib/script.js和/myProduct/docs/总是并行
的
。我希望能够使用document.location.href来检测当前
的
浏
浏览 2
提问于2021-09-14
得票数 0
回答已采纳
1
回答
在带有扩展语法
的
ECMAScript上使用
JSDoc
javascript
、
jsdoc
有没有人能告诉我,是否可以在JavaScript (更像ECMAScript)上使用带有一些附加功能
的
JSDoc
?例如,我有这样
的
代码: // do some stuff here正如您所看到
的
,它几乎是JavaScript那么我可以在这种语法上使用
JSDoc
吗
?有没有什么方法可以为它写一些插件? 谢谢。
浏览 0
提问于2013-04-11
得票数 1
回答已采纳
1
回答
如何在JetBrains IDE中指定闭包
的
"this“值
的
类型?
javascript
、
jquery
、
callback
、
phpstorm
、
webstorm
JetBrains
有
一篇关于
JSDoc
注释
的
旧博客文章,解释了如何将变量类型告知
集成
开发环境。然而,我似乎仍然找不到一种方法来告诉
集成
开发环境,在许多jQuery回调中
的
"this“值是HTMLElements。'input').each(function(){ });};在查看此注释<e
浏览 0
提问于2016-05-09
得票数 4
3
回答
在Notepad++中使用
jsDoc
javascript
、
notepad++
我想知道是否有人成功地将
jsDoc
与notepad++
集成
在一起,以便于代码注释。 我之前使用过Aptana,我相信它已经
集成
到ScriptDoc中了,但是Aptana变得非常慢。
浏览 3
提问于2010-04-05
得票数 9
回答已采纳
1
回答
JSDoc
输出在gulp
jsdoc
和标准CLI之间不一致
jsdoc
、
jsdoc3
我正在尝试为一组简单
的
JS代码(如下所示)构建
文档
。如果我使用gulp,那么
文档
是按照我所期望
的
方式创建
的
。如果我使用CLI,
文档
是不完整
的
。gulp
的
输出是以下文件:BASE.MOD1.
html
MOD1.js.
html
CLI
的
输出为以下文件: BASE.js
浏览 0
提问于2015-04-16
得票数 0
3
回答
Angularjs如何生成
HTML
代码
文档
javascript
、
angularjs
、
jsdoc
有没有人
有
记录/组织angularjs项目的经验,这样
JSDoc
就可以生成很好
的
注释(用于你
的
指令,控制器,过滤器等)在
HTML
格式中?目前,它生成
一个
带有_global类
的
文件,该文件指向我
的
应用程序
的
名称空间和一些函数,仅此而已…… 或者也许
有
更好
的
方法在angularjs中生成
html
版本
的
文档
块?PS:我正在使用标准
的<
浏览 1
提问于2012-10-11
得票数 16
回答已采纳
1
回答
用字符串呈现Markdown代码示例(
JSDoc
2MD)
markdown
、
jsdoc
、
jsdoc2md
我在JS文件中使用
JSDoc
注释,并运行
JSDoc
2MD将这些注释呈现为
一个
标记式readme.md文件。我希望在我
的
文档
中包括使用来自
的
JSDoc
的
代码示例。我很难用引号表示字符串。在我
的
JS评论中,我
有
: * // returns true
浏览 4
提问于2016-02-12
得票数 2
回答已采纳
2
回答
在JavaScript中是否
有
指定作者、日期或代码源代码
的
约定?
javascript
、
reference
、
comments
、
resourcereference
我想指定外部函数
的
来源(例如,来自StackOverflow )。此外,我想添加我
的
名字,日期和网站到我自己
的
功能。 当然,我可以用我想要
的
方式把一切都写进评论中。但是,我是否应该遵循某些约定呢?
浏览 2
提问于2021-11-19
得票数 1
回答已采纳
1
回答
打字编码文件
documentation
、
documentation-generation
我
的
问题相当简短: 如何正确地记录打字本代码?我发现,对于越来越大
的
项目来说,重要
的
是看一看
一个
函数,并立即知道它
的
参数、返回
的
内容和副作用等等。在
一个
函数之前仅仅有一堆评论是很累人
的
,大多数时候这些‘块’甚至在风格上看起来不一样。我正在寻找
的
是
一个
文档
工具,如javadoc或doxygen
的
类型记录。外面有什么东西
吗
?或者,是否
有
可能<
浏览 0
提问于2013-01-19
得票数 6
回答已采纳
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
给 Web 开发人员推荐的文档生成工具
常见的JavaScript编程开发文档生成工具分享
震惊!JavaScript 竟然可以类型推断!
入门干货之用DVG打造你的项目主页-Docfx、Vs、Github
数字翻译主要特性一览 高效 GUI文档 机器人工翻译 CPU多线程多进程
热门
标签
更多标签
云服务器
即时通信 IM
ICP备案
云直播
实时音视频
活动推荐
运营活动
广告
关闭
领券