microsoft / microsoft/TypeScript

code fence indentation inside JSDoc is removed

Đang mở
#56,583 3 bình luận 1 reaction 0 người được giao Xem trên GitHub

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

Bug Domain: Comment Emit Help Wanted
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

🔎 Search Terms

github typescript code fence indentation

🕗 Version & Regression Information
  • This is a crash
  • This changed between versions ______ and _______
  • This changed in commit or PR _______
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about _________
  • I was unable to test this on prior versions because time_
⏯ Playground Link

https://www.typescriptlang.org/play?#code/PQKhCgAIUgBBbAlgD0QO0gWkgFQPIAiek8AhgNYCmkALgBaIDOcSqGNpA5pACYD2kRn3iV66bulp1q-AMaMAdFBixZAG1KNmAZVEcARmurYcDZus3MADgCc+AN0Q9KzUoMTwrRyAANGogAoASh8SUTo+HilSGkhZUgx9agBXfx5lWgF-WPhktRpEL2pbPitKGwKXSD4AM0gEyHRGDjRZahjq1soFSF1qP0CQsPpIjOdGWRtCgr40JWgM0yY4jS1G1xIUdB6AVX9G2LVEKkE+AC5lDJ9rgCtGDIs1gFkATwBhVeZKZBpKNB4dHpSIZKMFIABvDKQSDAYCQBQIjIAXyu10u0GqNnRMGuPjuD0+kFeH0skG+v3+gJoBiMAW0wkoACFNJQSVoghCoTC4Qj5jAURjccpgOBHlSadRwUigA

💻 Code
/**
 * @mixin - TODO make this @mixin tag do something in the docs.
 * @class Settable - This class provides a simple `set()` method that can be used
 * to set multiple properties of an instance at once. See `set()` method
 * description.
 *
 * This class is a mixin. Use it like so:
 *
 * ```js
 * class MyClass extends Settable() {
 *   // ...
 * }
 * ```
 *
 * or
 *
 * ```js
 * class MyClass extends Settable(SomeBaseClass) {
 *   // ...
 * }
 * ```
 */
class Settable {}
🙁 Actual behavior
Screenshot 2023-11-28 at 10 12 36 PM
🙂 Expected behavior

Expect the // ... to be properly indented.

Additional information about the issue

Here's another example.

Screenshot 2023-11-28 at 10 15 31 PM

Note that example is using the trick described at https://github.com/microsoft/TypeScript/issues/47679#issuecomment-1763863693 to make decorators render "properly".

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu với các ví dụ TypeScript Playground được liên kết và tái hiện cách kết xuất code fence của JSDoc. So sánh độ thụt lề được hiển thị với các đoạn mã nguồn, sau đó xác minh rằng các dòng // ... vẫn được thụt lề đúng cách trong cả hai ví dụ.

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

Đánh giá

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

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.