Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Use a loose set of rules for consistent JSDoc comments

Đang mở
  • Có gì không ổn?
#1,539 9 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
eslint, javascript
Lĩnh vực
tooling

Hướng nghiên cứu

Issue không nêu tên tệp hay bài kiểm thử nào. Hãy bắt đầu bằng cách xác định cấu hình ESLint của repository và hướng dẫn JSDoc hiện tại, sau đó so sánh chúng với các tùy chọn valid-jsdoc được đề xuất. Công việc được xem là hoàn tất khi các quy tắc nhất quán đã thống nhất được áp dụng trong cấu hình phù hợp và được xác minh bằng các bước kiểm tra lint liên quan.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

While using JSDoc should not be mandatory, I think that its users should aim for more consistency, which may be achieved by the following set of loose ESLint rules:

"valid-jsdoc": ["error", {
  "prefer": {
    "arg": "param",
    "argument": "param",
    "class": "constructor",
    "return": "returns",
    "virtual": "abstract"
  },
  "preferType": {
    "Boolean": "boolean",
    "Number": "number",
    "object": "Object",
    "String": "string"
  },
  "requireReturn": false
}]
Ngôn ngữ chính
JavaScript
Star
148k
Fork
26.5k
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của airbnb/javascript

Tất cả issue của airbnb/javascript

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.