我希望你可以从Angular的角度出发担任翻译工作(但任何建议都会有所帮助)。我在我的函数上使用了JSDoc,但这使得代码看起来很混乱。我只是想知道是否有一种方法将JSDoc移动到某种外部文件中。
以下是我的JSDoc示例:
/**
* Does a GET call on the service MyGetCall
* @param {string} pUserID - 1st Parameter: User Login ID
* @param {string} pPassword - 2nd Parameter: User Password
* @returns The Call's Http Observable (subscribe to this function).
* @example this.flowservice.MyGetCall('Johnny', 'MySuperSecretPassword')
* .subscribe(response => {
* console.log(response)
* });
*/
MyGetCall(pUserID: string, pPassword: string): Observable<any> {
const temp = this.httpclient.get<JSON>(`http://XXX/MyGetCall?userid=${pUserID}&password=${pPassword}`, {headers: this.headers});
return temp;
}
因此,在这个例子中,我希望删除所有的JSDoc,并将其放入某种外部文件(jsdocs.xxx)中。这个文件可能会像这样:
MyGetCall:
/**
* Does a GET call on the service MyGetCall
* @param {string} pUserID - 1st Parameter: User Login ID
* @param {string} pPassword - 2nd Parameter: User Password
* @returns The Call's Http Observable (subscribe to this function).
* @example this.flowservice.MyGetCall('Johnny', 'MySuperSecretPassword')
* .subscribe(response => {
* console.log(response)
* });
*/
MyOtherFunction:
...
MyOtherOtherFunction:
...
然后我可以在某个地方导入这个文件(jsdocs.xxx),让它能够与我的应用程序一起工作。对于使用过 JSDoc 的任何人,我希望这是有意义的。
@function <函数名称>
标签。 - garlon4