javascript函數文檔新手問題

Question

新手警報！

當您在下面的代碼中需要一個模塊，並且將鼠標懸停在從該模塊進行調用的函數上時，您會彈出有關該函數的一些文檔，例如參數，返回和拋出等

const AWS = require("aws-sdk");
const cognito = new AWS.CognitoIdentityServiceProvider({ apiVersion: "2016-04-18" });

在我自己的模塊中，我編寫了函數然后要求它們，我按照以下示例記錄了每個函數

/**
 * Given a user's profile, create a new session (kill any previous sessions)
 * @param profile The users profile
 * @throws Exception if the user is not a valid user.
 */ 

當我將鼠標懸停在包含功能代碼的模塊中的功能上時，可以看到出現文檔框。

但是，當我在實際調用該函數的模塊中懸停該函數時，我什么也沒得到。

您還將獲得智能感知類型功能，因此在鍵入cognito時。 您會看到一個包含所有可用功能的彈出窗口。

缺少什么讓我的功能也像這樣出現？ 它們都使用導出

module.exports.funcName = funcName;

任何人？

提前致謝

Answer 1

希望這可以幫助其他新手像我一樣做愚蠢的事情。

終於找到了我問題的答案。 基本上，我在本地筆記本電腦上的路徑與構建服務器上的路徑並不完全相同，因此我的本地js文件具有定義為適合構建服務器的路徑。 這意味着在本地文件上，這些文件將無法正確解析，因此將不會導入js doc refs。

一旦我在本地服務器和構建服務器上對齊了路徑，然后正確導入的文件和viola JS doc就可以正常工作了。

衛生署！