Cách thêm ngắt dòng trong tài liệu C # .NET


196

Điều này sẽ dễ dàng hơn ...

Tôi muốn thêm ngắt dòng "được mã hóa" vào tài liệu XML trong mã của mình

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Như bạn có thể thấy, tôi đã tìm thấy một số câu trả lời thể hiện việc thêm dấu ngoặc <và>. Thật thú vị, ngắt dòng 'ol <br /> tốt không tạo ra ngắt dòng trong cửa sổ bật lên Intellisense.

Tôi thấy phiền phức ...

Bất kỳ đề xuất?


3
Có thể sử dụng <br/> để tạo ngắt dòng kể từ Visual studio 2019. Tham khảo câu trả lời tại đây .
23bl

Câu trả lời:


314

Bạn có thể sử dụng <para />thẻ để tạo ngắt đoạn hoặc bạn có thể bọc văn bản trong <para></para>thẻ như một cách để nhóm văn bản và thêm dòng trống sau nó, nhưng không có tương đương <br />hoặc bất cứ điều gì tương tự. (Theo bài đăng trên diễn đàn MS cũ này là do thiết kế.) Bạn có thể lấy danh sách các thẻ có sẵn trong bài viết tài liệu này từ MS. Tài liệu mã của bạn

Ví dụ (dựa trên mẫu OP gốc):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

5
Aha! Bây giờ đang nấu ăn! Cảm ơn! Điều này đã làm phiền tôi trong một thời gian dài ... Tôi thấy tùy chọn para được liệt kê, nhưng cho rằng đó là một phím tắt "paramater".
Tinkerer_CardTracker

2
Không làm việc cho tôi. Sử dụng VB.NET trên VS 2010, đã thử và không có tùy chọn tham số được tô màu của Powertools, <para>các thẻ bị bỏ qua và mọi thứ được trộn thành một dòng duy nhất trong Intellisense. Tìm thấy câu hỏi này, nơi Hans giải thích vấn đề: stackoverflow.com/questions/7070737/ .
Neolisk

1
Đảm bảo bạn cũng thêm thẻ đóng </ para> =)
link64

85
Điều tệ hại về điều này là nó thực sự thêm một dòng trống, thay vì chỉ một dòng mới.
Devid

6
Vì vậy, có ai tìm thấy một cách để thực sự chèn một dòng thay vì hai?

75

Đây là cách sử dụng của tôi, như <br/>, nó đang hoạt động :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

8
Tại sao câu trả lời này bị bỏ qua? Nó hoạt động và dường như là một giải pháp tốt hơn nhiều so với việc sử dụng <para>&#160;</para>, <para>&nbsp;</para>hoặc nhân vật vô hình ...
Dinei

Điều này hoạt động cho dòng mới, nhưng sẽ không chèn một dòng trống giữa những thứ như các tùy chọn khác làm.
Yushatak

15
Trong các phiên bản gần đây của VS <para/>dường như thêm một dòng trống, không chỉ là ngắt dòng.
Dinei

2
@IlPADlI, +1 cho ví dụ sử dụng. Xác nhận làm việc trên Bản cập nhật cuối cùng của VS 2012 5.
Dennis T --Reinstate Monica--

9
VS 2017: thêm dòng trống, không chỉ đơn giản là ngắt dòng ... microsoft chắc chắn thích cho chúng tôi biết những gì chúng tôi muốn làm ...
Assimilater

39

Kể từ Visual Studio 2019, sử dụng <br/>cho các dòng mới trong các bình luận.

Thí dụ:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

nhập mô tả hình ảnh ở đây

Lưu ý rằng không có thêm dòng bổ sung khi chúng tôi sử dụng <br/>thay vì <para>.


4
Vẫn hữu ích vì câu hỏi này là kết quả hàng đầu của google về cách thêm ngắt dòng trong tài liệu C #.
Dan

27

Thêm một <para>thẻ với một char đặc biệt trong đó, char char 255 hoặc char vô hình .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Nó sẽ hoạt động như thế này:

nhập mô tả hình ảnh ở đây


8
Điều này rất hữu ích, tuy nhiên &nbsp;không hiệu quả, thay vào đó hãy sử dụng/// <para>&#160;</para>
Robert H

1
Cá nhân tôi giữ /// <para> </para>trong một lưu ý dính. Sau đó, nó chỉ cần sao chép và dán! (Và nó hoạt động - ít nhất là đối với tôi)
Joel

2
Tôi không biết tại sao, nhưng sao chép dán /// <para> </para>hoàn toàn không hoạt động. /// <para>&#160;</para>làm!
wenqiang

8
Thay vì sử dụng <para>thẻ giữa các khối văn bản, bạn nên sử dụng <para>thẻ xung quanh tất cả các đoạn ngoại trừ đoạn đầu tiên trong <summary>phần tử. Đối với <typeparam>, <param>, <value>, <exception>, và <returns>các yếu tố, sử dụng chúng xung quanh tất cả các đoạn văn bản nếu bạn có nhiều hơn một (không bắt buộc nếu bạn chỉ có một cho những yếu tố này). Đối với tất cả các thành phần khối khác (bao gồm cả <note>bên trong một thành phần khối khác), hãy sử dụng <para>các thẻ xung quanh tất cả các đoạn, ngay cả khi bạn chỉ có một.
Sam Harwell

1
Nguồn: Tôi là tác giả của điều này, bao gồm hầu hết các phong cách trình bày: openstacknetsdk.org/docs-master/html/ợi
Sam Harwell

3

<br></br><br />dường như không hoạt động, và đôi khi nó không thực sự làm cho các <para>câu tách biệt nhiều như mong muốn có một dòng trống để phân tách mối quan tâm. Tôi đang đề cập đến vấn đề này ở đây bởi vì câu hỏi này dường như dành cho phụ huynh đối với nhiều câu hỏi đóng có tính chất này.

Điều duy nhất tôi tìm thấy để làm việc là

<para>&#160;</para>

Ví dụ

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Kết quả trong

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.