<p>使用jsDoc可通过@param {String}标注字符串参数类型,如/* @param {string} name /,推荐小写{string}格式,避免拼写错误和漏括号,结合typescript可增强类型检查。</p>

在javaScript中,并没有像Java那样的“注解”(Annotation)语法,但你在使用TypeScript或配合JSDoc工具时,可以通过注解方式为函数参数标注类型,包括字符串类型。下面介绍如何正确标注字符串类型的参数。
使用JSDoc标注字符串类型
JSDoc是一种广泛使用的javascript文档注释标准,支持类型标注。通过@param标签可以明确指定参数的类型。
标注字符串类型的基本语法如下:
/** * @param {string} name – 用户名 */ function greet(name) { console.log(“Hello, ” + name); }
说明:
- {string} 表示该参数应为字符串类型
- name 是参数名
- 后面可加描述,如“用户名”
支持的字符串类型写法
JSDoc中表示字符串类型有几种等效写法:
- {string} — 最常用
- {String} — 首字母大写也可识别
- {typeof String} — 不推荐,语义不符
建议统一使用 {string} 小写形式,符合TypeScript和主流规范。
与TypeScript联合使用
如果你在TS环境中使用JSDoc,也可以结合类型检查增强提示:
/** * @param {string} message – 提示信息 * @returns {string} 拼接后的结果 */ function formatMessage(message) { return “Info: ” + message; }
这样即使不写.ts文件,在支持TS的语言服务中也能获得准确的类型提示和错误检查。
常见错误与注意事项
避免以下常见问题:
- 漏写花括号:@param string name ❌ 应为 @param {string} name
- 拼错类型名:{str} 或 {text} 不被识别
- 混淆值与类型:不要写成 “hello” 这样的具体值作为类型
确保编辑器启用了JSDoc支持(如vs code默认支持),才能看到类型提示效果。
基本上就这些。用{string}包裹在花括号中,配合@param即可清晰标注JS函数中的字符串参数。不复杂但容易忽略细节。