首页 > 其他分享 >CocosCreator + Vscode + Ts 代码注释生成文档,利用typedoc

CocosCreator + Vscode + Ts 代码注释生成文档,利用typedoc

时间:2023-07-19 19:55:28浏览次数:40  
标签:npm typedoc Vscode ts Ts json 文档 tsconfig

需求: 脚本的代码注释,生成为文档
基本搭建环境: (cocoscreator 2.4.x + vscode + ts) 、(nodejs + npm)

步骤:
1、安装typedoc:
npm install -g typedoc

2、项目根目录添加/创建 typedoc.json 文件

3、然后再项目 tsconfig.json 文件 加入 (4步骤报错可选)

"downlevelIteration": true

4、配置 typedoc.json, 参考如下
`

{
"name": "api说明", // 文档项目名称
"entryPoints": ["./assets//*.ts"], // TypeScript文件的入口点,通常是存放您的脚本的目录
"tsconfig":"./tsconfig.json", // 指定config路径
"out": "docs", // 文档输出目录-自己创建,可以自定义
// "mode": "file",
"theme": "default",// 默认主题
// // "includes": "path/to/your/customIncludes", // 可选,如果您有自定义的文档部分,可以指定其路径
"exclude": [
"
/node_modules/", // 排除node_modules文件夹
"
/build/", // 排除build文件夹,如果有的话
"
/*.d.ts" // 排除所有的TypeScript声明文件
],

}

`

5、项目终端运行 typedoc 即可

6、生成后运行文件里的 index.html即可看到注释

其他可遇到的问题:
1、如果版本问题可以用 : npm install -g typedoc@latest

标签:npm,typedoc,Vscode,ts,Ts,json,文档,tsconfig
From: https://www.cnblogs.com/AMQF/p/17566580.html

相关文章

  • 九、DataArts Studio
    功能总览: 基本概念: 主题设计:通过分层架构表达对数据的分类和定义,帮助理清数据资产,明确业务领域和业务对象的关联关系。 主题域分组:基于业务场景对主题域分组。主题域:互不重叠数据的高层面的数据分类,用于管理其下一级的业务对象。业务对象:指企业运作和管理中不可缺少......
  • 【netstat】 netstat 查看端口的指令
    先来看两个netstat-natp:-n:以数字形式显示IP地址和端口号,而不进行反向解析。-a:显示所有的连接和监听端口,包括TCP和UDP。-t:仅显示TCP协议的连接。-p:显示与连接关联的进程信息。因此,netstat-natp命令将以数字形式显示所有的TCP和UDP连接,并显示与这些连接关联的进程信息。n......
  • struts与spring集成
    1.struts与spring集成Spring和struts整合的四种方式。1.使用Spring的ActionSupport2.使用Spring的DelegatingRequestProcessor类。3.全权委托。org.springframework.web.struts.DelegatingActionProxy4.使用org.springframework.web.struts.AutowiringRequestProcessor......
  • RTSP流媒体服务器LntonNVR(源码版)云服务平台下载录像后无法拖动时间轴的问题解决方案
    LntonNVR安防视频云服务平台是基于RTSP/Onvif协议的视频接入、处理及分发平台,可以分发出RTSP、RTMP、WS-FLV、HTTP-FLV、HLS、WebRTC等格式的视频流,可实现在全终端(PC、手机、平板、电子大屏/电视墙等)播放监控视频。有用户反馈,在使用LntonNVR下载录像时,下载后的录像时间无法拖动时间......
  • netstat命令
    netstat命令查看Linux中网络系统状态信息补充说明用来打印Linux中网络系统的状态信息,可让你得知整个Linux系统的网络情况。语法netstat(选项)选项-a或--all:显示所有连线中的Socket;-A<网络类型>或--<网络类型>:列出该网络类型连线中的相关地址;-c或--continuous:持续列出网......
  • logits 与 pre-logits
    logits为fc的输出,应用softmax之前的向量,(b,len)pre-logits这个东西我是从论文《Tied-Augment:ControllingRepresentationSimilarityImproves DataAugmentation 》中看到的,根据源码的解释,pre-logits为特征图flatten之后(应用fc之前)的向量: 特此记录......
  • 使用mvn test -Dtest=具体方法名,结果报:No tests were executed!
    执行命令:mvnw.cmdtest-Dtest=com.cy.store.mapper.UserMapperTests#print问题描述:[ERROR]Failedtoexecutegoalorg.apache.maven.plugins:maven-surefire-plugin:2.22.2:test(default-test)onprojectstore:Notestswereexecuted! (Set-DfailIfNoTests=falseto......
  • vscode import 点击ctrl + 右键 进入当前文件
    项目根目录:jsconfig.jsonimportimportTablefrom"./importTable";//.vue点击不进去,.js可以点击进去,需要带上./importTable.vue{"compilerOptions":{"target":"es6","baseUrl":".","paths":......
  • CANoe执行vTESTstudio测试用例
    来源CANoe执行测试用例_哔哩哔哩_bilibili 打开对应的CANoe工程,在主菜单中选择Test 可以看到有TestUnits和TestModules,两者有什么区别呢?如果是CANoe创建测试节点编写的测试用例,需使用TestModules执行测试,若使用vTESTstudio编写的测试用例,则须使用TestUnits执行测试。1......
  • 直播app源码,Bootstrap响应式布局简单使用
    直播app源码,Bootstrap响应式布局简单使用1.创建html模版,并引入Bootstrap的样式:<!doctypehtml><!--html5类型--><html> <head>  <metacharset="utf-8"> <!--页面编码-->  <metahttp-equiv="X-UA-Compatible"content="I......