jsDoc -不排除标记为@private的方法

jsDoc是一种用于JavaScript代码文档化的标记语言和工具。它允许开发人员通过注释代码来描述函数、方法、类和变量的用途、参数、返回值和其他相关信息，以便生成清晰的文档。

jsDoc的主要作用是提供代码文档化和自动化文档生成。通过使用jsDoc注释，开发人员可以更好地理解代码的功能和用法，并且可以生成具有良好结构和易读性的文档。这对于团队协作、代码维护和项目文档化非常有帮助。

对于标记为@private的方法，它表示该方法是私有的，只能在当前类或对象内部使用，不能被外部访问或调用。私有方法通常用于封装内部逻辑，隐藏实现细节，提高代码的安全性和可维护性。

以下是jsDoc的一些常用标记：

@param：用于描述函数或方法的参数，包括参数名称、类型和描述。
@returns：用于描述函数或方法的返回值类型和描述。
@throws：用于描述函数或方法可能抛出的异常类型和描述。
@example：用于提供代码示例，展示函数或方法的使用方式。
@see：用于引用其他相关文档或资源。

在腾讯云的产品中，与jsDoc相关的产品是腾讯云文档生成工具（Tencent Cloud Document Generator）。该工具可以根据代码中的jsDoc注释自动生成文档，并支持自定义模板和样式。您可以通过以下链接了解更多关于腾讯云文档生成工具的信息：

腾讯云文档生成工具：https://cloud.tencent.com/document/product/1159/44225

相关·内容

不是Typescript用不起，而是JSDoc更有性价比？

TS不香了？ 2023年，几条关于 Typescript 的新闻打破了沉寂，让没什么新活好整的前端开发圈子又热闹了一番。...编译速度缓慢，而 esbuild 等实现目前还不支持装饰器等特性编译体积会因为各种重复冗余的定义和工具方法而变大相比于 Svelte 的开发者因为不厌其烦而弃用 TS 的事件本身，其改用的 JSDoc...，比较理想的解决方法是前端团队兼顾 Node.js 中间层 BFF 的开发，这样无论是组织还是技术都能最大程度通用。...但从业内近年的诸多实践来看，这无疑是很难实现的：即便前端团队有能力和意愿，这样的 BFF 模式也难以为继，此中既有 Node.js 技术栈面临复杂业务不抗打的问题，更多的也有既有后端团队的天然抗拒问题。...： /** * @typedef {Object} MyPojo * @property {Integer} [id] * @property {String} [name] */ 在转换的方法上

3031 0

什么是 TypeScript 4.1 中的模板字面类型？

@see 标签的编辑器支持在编辑器中使用 TypeScript 时，现在对 JSDoc 标签 @see 有了更好的支持，这将改善TypeScript 4.1的可用性： // @filename: first.ts...您可以通过指定 --noLib 编译器命令行标志或在 tsconfig.json 中配置 noLib 为 true 来排除它。...abstract 成员不能被标记为 async 在另一个重大更改中，标记为 abstract 的成员不能被再标记为 async。...是将变量强制转换为布尔值（真或假）的一种简便方法。...: string; } 不匹配的参数将不再关联过去，彼此不对应的参数在 TypeScript 中通过将它们与 any 类型关联而彼此关联。

3.9K1 0

JSDoc 初探：代码内的文档标记

假设你想要记录诸如模块、名称空间、类、方法、方法参数等内容。 JSDoc注释通常应该放在记录代码之前。为了被 JSDoc 解析器识别，每个注释必须以 /** 序列开头。...在阅读和使用第三方库时，可以通过查看JSDoc生成的文档来了解函数和方法的使用方式、参数、返回值等信息。...在JSDoc中，可以使用各种标签来描述代码的不同方面，例如：@param：用于描述函数或方法的参数类型和含义；@returns：用于描述函数或方法的返回值类型和含义；@throws：用于描述函数或方法可能抛出的异常类型和含义...如果不传入 type 参数，则函数中可以通过 if (!type) 进行判断，避免出现未定义的错误。使用=标记具有默认值的参数or可选参数在JSDoc中，可以使用 = 符号来标记具有默认值的参数。...需要注意的是，在JSDoc中标记参数具有默认值并不会改变函数或方法的实际调用方式，你可以只在注释中写好标记的默认参数，而不写在代码中，反之亦然（君子协定）。

1671 0

15个Typescript 5.0 中重要的新功能快速了解一下

JSDoc 中的@satisfies 支持 TypeScript 5.0 中新的@satisfies JSDoc 标记使您能够指定函数实现满足特定接口。...`; } 在这个例子中，greeter 函数被标记为@satisfies JSDoc 标签，表明它满足 Greeter 接口。 10....JSDoc 中的@overload 支持 TypeScript 5.0 添加了对 @overload JSDoc 标记的支持，允许您在 JavaScript 代码中为单个实现定义多个函数签名。...编辑器中不区分大小写的导入排序 TypeScript 5.0 通过不区分大小写改进了编辑器中的导入排序。在组织导入时，此更改会导致更自然和直观的排序顺序，从而使代码更清晰、更易读。 13....lib.d.ts 更改：更改 DOM 类型的生成方式可能会对现有代码产生影响。值得注意的是，某些属性已从数字转换为数字文字类型，并且用于剪切、复制和粘贴事件处理的属性和方法已跨接口移动。

2383 0

JavaScript 重构攻略

方法四，很多 JS 框架都提供了易于使用的 JS 动态加载的方法，比如 JQuery 的 loadScript 方法，这里不讨论了。...顺便罗嗦一句，和闭包相反的，不正是不包含任何未绑定变量的函数式代码吗？...child[ele]) //在 child 不包含该属性或者方法的时候，才会拷贝 parent 的一份 child[ele] = parent[ele]; } })...那么，JavaScript 中，不仅仅方法的调用者可以作为一个参数传入，方法本身也可以作为参数传入（即所谓方法闭包），这样，所有变化点都控制在这个参数之中，不也实现了我想要的接口规约的效果吗： function...现在换个思路，通过使用 var 来定义 User 中的 name 属性，并且通过 getName 方法来给它暴露访问入口，实现了 private 一样的效果： var User = function(name

1.8K2 0

TS in JS 实践指北

大白话就是：为 JS 的现代能力提供支持。因此 VSCode 内置了 Dom 和 ES2015、ES2016、ES2017 ... 的语法特性也不奇怪了。...包内自带的声明文件不指定默认入口：有的 JS 文件会自带声明文件。只要声明文件的前缀和 JS 文件前缀相同，VSCode 就会自动引入声明文件。...*/就是一个典型的 JSDoc 的语法。其中@param表示该方法接收一个名为name的string类型的参数。...string type 这就是 JSDoc 解决 JS 里函数缺失 type 能力的方法。JSDoc 里@param的这个标记，在{}中间代表的就是一个 TS 的 type 类型。...稍微列举下目前我遇到过的问题 •无法支持@private、 @protected这类 tag 修饰，表现在还是在提示中给了出来•无法直接对某个函数定义函数重载，需要依靠对象的形式•很多 tag 不支持，

4.4K2 0

PHPDoc、JSDoc、Vue JSDoc相关的语法，持续记录

@throws @throws 异常类型异常说明，用于指定方法或函数所可能抛出的异常。...@deprecated @deprecated 已弃用的方法或函数，用于标记方法或函数已经过时不推荐使用。.../** * 弃用的方法 * @deprecated 该方法已被弃用，请改用 newMethod 函数。...*/ function OldMethod(){ // 该方法已被弃用 } JSDoc JSDoc 是一种用于为 JavaScript 代码提供文档的注释规范。 1....的文档注释使用的是基于 JSDoc 的风格，但是添加了Vue.js 特有的运行时和模板相关的标签。

2802 0

CA1062:验证公共方法的参数

值规则 ID CA1062 类别设计修复是中断修复还是非中断修复非中断原因外部可见方法取消引用其中一个引用参数，而不验证该参数是否 null（Visual Basic 中 Nothing）...如果该方法设计为仅由已知程序集调用，请将方法标记为 internal并将 InternalsVisibleToAttribute 特性应用于包含该方法的程序集。...排除特定符号排除特定类型及其派生类型排除扩展方法“this”参数 Null 检查验证方法可以仅为此规则、为所有规则或为此类别（设计）中的所有规则配置这些选项。...排除特定符号可以从分析中排除特定符号，如类型和方法。...排除扩展方法“this”参数默认情况下，此规则分析并标记扩展方法的 this 参数。

7103 0

@SysLog – AOP最佳实践：日志规范注解

实现排除部分入参打印3、打印异常日志4、打印场景（如不指定场景是干嘛的，会打印全限定类名）、操作人、入参上手编码1、编写拦截器import lombok.extern.log4j.Log4j2;import...// 排除打印的接口参数名数组形式 String[] excludes() default {}; // 是否打印全部接口参数 boolean allParams() default...如果不传入，优先使用log作为场景名，如果还没有，就以全限定类名为准 String errorLog() default ""; // 是否打印当前用户 boolean printUser...(Exception e) { log.error(ExceptionUtils.getStackTrace(e)); } } /** * 在方法执行完成执行的内容...已经过滤排除的内容了！

8961 0

大批量生成假数据，faker.js获得近28k个Star

整理 | 夕颜图源 | 视觉中国来源 | CSDN（ID:CSDNnews）近日，GitHub上一个生成假数据的项目faker.js火了，攀升Trendinging榜单第二，标星目前已超过27.1k...包含一个超级有用的生成器方法Faker.fake，用于胡须字符串格式与faker API组合。...创建faker.js的方法浏览器 Faker.js的好处之一，是不仅可以使用在服务器端的JavaScript，还可以应用在浏览器端的JavaScript，代码如下： <script src = "faker.js...另外，faker.js是支持多种语言<em>的</em>，默认设置语言是英语，但可以自己设置，<em>方法</em>也很简单： // sets locale to de faker.locale = "de"; az ar cz de...浏览器绑定 npm run browser 创建JSDocs JSDOC v3 HTML API documentation npm run jsdoc 创建ReadMe faker.js的ReadMe.md

2.2K2 0

Spring Cloud 应用如何注册到多个注册中心

点击蓝色“程序猿DD”关注我哟加个“星标”，不忘签到哦 ?...提示的解决方案是将其中的一个 bean 标记为 @Primary，但是我们既无法修改 netflix-eureka-client 的源码，又无法修改 alibaba-nacos-discovery 的源码...使用如下方法，将其排除，在 application.properties 中添加如下配置，然后重新启动应用。...总结一下，从 init方法来看，将 AutoServiceRegistrationAutoConfiguration 排除相当于使 AutoServiceRegistrationProperties...来排除重点讲一下第二种方法 public class RegistryExcludeFilter implements AutoConfigurationImportFilter { private

4.4K4 0

WEB缓存探究

，而且因为这个方法太老了，如果你不需要估计那些史前客户的感受，完全可以不加?...Cache-Control Cache-Control 标头是在 HTTP/1.1 规范中定义的，取代了之前用来定义响应缓存策略的标头例如 Expires。...它不是必须的，因为明确的缓存信息已表示响应是可以缓存的 private 通常只为单个用户缓存，不允许任何中间缓存对其进行缓存 no-cache 表示必须先与服务器确认返回的响应是否发生了变化 no-store...同时不要忘记给文件名加上指纹，以便及时更新改动 JavaScript同样设置为1年后到期，但标记为private，因为它可能会包含某些用户私人数据，这是CDN不应缓存的。...图像缓存时不包含版本或唯一指纹，并设置为1天后到期。

7174 0

八皇后问题的递归解法（最易理解的版本）

在8*8的国际象棋上摆放八个皇后，使其不能互相的攻击，也就是说，任意的两个皇后不能放在同一行或则是同一个列或者是同一个对角线上，问有多少个摆放的方法本算法的思路是按行来规定皇后位置，第一行放置一个皇后...在从一轮循环进入下一轮循环之前，算法需要清除在上一轮被标记为不可放置皇后的标记，也就是回溯。...因为进入下一轮循环之后，同一行的皇后的列的位置会发生了变化，之前被标记为不可放置皇后的列和正反对角线位置都已经失效。...;// 分配8X8的数组，充当棋盘，存放皇后 private int resultCount = 0;// 记录皇后的放置方法的总数 private int[] Queenplace...; column++)// column表示列标，该层循环的作用是用于询问第row行，第column列是否可以放置皇后 { if (Queencount[row]

1.6K2 0

大话 JavaScript（Speaking JavaScript）：第二十六章到第三十章

： var arr = new Array('a', 'b', 'c'); // never ever var arr = [ 'a', 'b', 'c' ]; // yes 不要聪明本节收集了一些不推荐的聪明用法...然而，通常最好使用更明确的替代方法，比如Math.round()。转换为整数概述了所有转换为整数的方法。...JSDoc 生成的 HTML 输出。 JSDoc 网站上的自述文件解释了如何安装和调用这个工具。 JSDoc 的基础知识 JSDoc 的全部内容都是关于文档化实体（函数、方法、构造函数等）。...这些 API 有所不同，通常差异很大，因此您必须帮助 JSDoc 弄清楚发生了什么。以下标签让您可以做到这一点： @constructor 将函数标记为构造函数。 @class 将变量或函数标记为类。...如果对象文字有一个@constructs方法，您需要告诉 JSDoc 关于它，这样它才能找到实例属性的文档。

1241 0

ASP.NET Core ResponseCache进行缓存操作

MVC 操作（方法） – 方法级特性覆盖类级特性中指定的设置。 [ResponseCache] 参数 Duration 设置缓存的存储时间(以秒为单位)。...设置“Cache-control”标题为“private”。...，会直接从缓存中取，不会再进入我们的方法。...中间件在为缓存的响应提供服务时计算一个新值。缓存条件请求必须导致服务器响应，状态代码为200（正常）。请求方法必须为 GET 或 HEAD。...Cache-Control 标头参数必须是有效的，并且响应必须标记为 “public” 且未标记为 “private”。

2.9K2 0

Envoy架构概览(4):健康检查和连接池

在这种情况下，在使用/ healthcheck / fail管理端点时，能够快速排除上游主机仍然很有用。...如果此报头由上游主机设置，则Envoy将立即将主机标记为主动运行状况检查失败。...请注意，只有在主机的集群配置了活动的健康状况检查时才会发生这种情况如果Envoy已通过/ healthcheck / fail admin端点标记为失败，则运行状况检查过滤器将自动设置此标头。...这种方法的缺点是整体配置变得更加复杂，因为每个运行状况检查URL都是完全自定义的。 Envoy HTTP健康检查器支持service_name选项。...如果设置了此选项，运行状况检查程序会另外将x-envoy-upstream-healthchecked-cluster响应标头的值与service_name进行比较。如果值不匹配，健康检查不通过。

1.6K6 0

二.SpringBoot配置lombok

简介： Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不会用到，但是某些时候仍然需要复写，以期方便使用的方法；在使用...，自动生成生成setter/getter方法，final变量不包含，还可以指定访问范围 @ToString：注解在类上，可以自动覆写toString方法，当然还可以加其他参数，例如@ToString(exclude...=”id”)排除id属性，或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法，包含所有属性 @EqualsAndHashCode...@RequiredArgsConstructor：注解在类上，将标记为@NoNull的属性自动生成构造方法（如果运行中标记为@NoNull的属性为null,会抛出空指针异常） @Data：注解在类上，...@Synchronized：用在方法上，将方法声明为同步的，并自动加锁，而锁对象是一个私有的属性$lock或$LOCK，而java中的synchronized关键字锁对象是this，锁在this或者自己的类对象上存在副作用

6652 0

TypeScript 5.0 正式发布！

TypeScript 5.0 实现了新的装饰器标准、更好地支持 Node 和打构建工具中的 ESM 项目的功能、库作者控制泛型推导的新方法、扩展了 JSDoc 功能、简化了配置，并进行了许多其他改进。...支持 @satisfies JSDoc 支持 @overload 编辑器中不区分大小写的导入排序完善 switch/case 优化速度、内存和包大小其他重大更改和弃用全新装饰器装饰器是即将推出的...loggedMethod 的第二个参数被称为“ context 对象”，它包含一些关于如何声明装饰方法的有用信息——比如它是 #private 成员还是静态成员，或者方法的名称是什么。...TypeScript 5.0 现在允许 JSDoc 使用新的 @overload 标签声明重载。每个带有 @overload标签的 JSDoc 注释都被视为以下函数声明的不同重载。...这有助于捕获在不区分大小写的文件系统上编写的代码的差异问题。

3.8K7 0

SpringBoot是如何实现自动配置的？--SpringBoot源码（四）

4.1 分析自动配置的主要逻辑这里继续深究前面 4 分析SpringBoot自动配置原理这节标【1】处的 this.group.process方法是如何处理自动配置相关逻辑的...；【3】排除掉要exclude的自动配置类后，然后再调用filter方法进行进一步的过滤，再次排除一些不符合条件的自动配置类；这个在稍后会详细分析。...的filter方法： // AutoConfigurationImportSelector.java private List filter(List configurations...可以看到最终是调用ClassNameFilter的matches方法来判断@ConditionalOnClass指定的类存不存在类路径中,若不存在的话，则返回不匹配。...我们直接点进fireAutoConfigurationImportEvents方法看看其是如何触发事件的： // AutoConfigurationImportSelector.java private

1.2K0 0

【Java 基础篇】Java transient 关键字详解：对象序列化与非序列化字段

这意味着在将对象转换为字节流时，transient 修饰的成员变量将被忽略，不包含在序列化的数据中。为什么使用 transient？...通过将这些属性标记为 transient，可以确保它们在序列化过程中不被泄露。临时状态：某些属性仅在对象的生命周期内具有意义，不需要在不同的运行时环境中保留它们的状态。...将这些属性标记为 transient 可以减小序列化数据的大小，提高性能。...因此，如果需要在反序列化后为 transient 属性赋予非默认值，需要自行在对象的构造函数或反序列化方法中处理。版本兼容性：在使用 transient 关键字时，需要注意对象的版本兼容性。...为了解决这个问题，可以使用 serialVersionUID 进行版本控制，确保序列化和反序列化的兼容性。总结 transient 关键字允许我们在对象序列化过程中选择性地排除某些属性。

3622 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云