Có cách cụ thể nào để khai báo một phương thức hoặc một hàm để trả về void trong JsDoc không? Hiện tại, tôi tin rằng đó voidlà giá trị trả về mặc định và các giá trị trả về khác phải được cung cấp cụ thể:

/**
 * @return {Integer} The identifier for ...
 */

Tôi không tin rằng bạn phải chọn từ một tập hợp các kiểu trong JsDoc ... bạn có thể sử dụng bất kỳ tên kiểu nào bạn muốn (dấu ngoặc nhọn cho biết đó là một kiểu), vì vậy bạn có thể chỉ cần làm:

@return {Void}

Mặc dù, điều này có lẽ đúng hơn đối với JavaScript:

@return {undefined}

Trình biên dịch đóng cửa

Theo tài liệu của Trình biên dịch đóng cửa của Google nếu không có gì được trả lại, thì chú thích @return sẽ bị bỏ qua.

Nếu không có giá trị trả về, không sử dụng thẻ @return.

Nguồn: https://developers.google.com/closure/compiler/docs/js-for-compiler#tags

jsdoc-toolkit

Tuy nhiên, tài liệu khác cũng nói rằng returnType và returnDescription là các tham số tùy chọn.

returnType - Tùy chọn: loại giá trị trả về.

returnDescription - Tùy chọn: bất kỳ mô tả bổ sung nào.

Nguồn: https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns

Tóm lược

Bạn có thể loại bỏ chú thích trả về hoặc bao gồm nó mà không có bất kỳ tham số nào.

Nhìn vào tài liệu ESlint mà họ sử dụng @returns {void}

Nguồn: http://eslint.org/docs/rules/valid-jsdoc

Vì tôi cần cung cấp @returnscho mỗi chức năng để vượt qua các bài kiểm tra để đẩy mã cho các dự án nhất định, điều này là bắt buộc trong trường hợp của tôi.

Nếu bạn cần phải nói to rằng không có gì được trả lại, bạn có thể nói điều đó trong mô tả ở dạng tự do . Điều này rất hữu ích để làm rõ các tình huống mà người dùng có thể mong đợi thứ gì đó được trả lại. Tất nhiên, việc đặt tên phù hợp cho hàm và các tham số sẽ làm cho kiểu trả về mong đợi trở nên rõ ràng, nhưng không phải lúc nào cũng có thể thực hiện được.

/**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};