Bất kỳ ý tưởng quy ước '#region chỉ thị' nào của .NET?

Question

Tôi thực sự đánh giá cao khả năng xác định các vùng trong mã của bạn, vì nó cải thiện khả năng đọc một cách điên rồ.

Anyways, tôi muốn có tất cả mọi người sử dụng cùng một ước trong mọi tầng lớp (với thứ tự được xác định trước của tất cả các vùng) như:

• Private Fields
• Constructors
• Lớp Thuộc tính
• Trình xử lý sự kiện
• ...

Bạn có bất kỳ đề xuất nào về việc phân chia này có thể trông như thế nào (Những vùng nào có ý nghĩa và họ nên có tên nào) và theo thứ tự nào chúng sẽ được xác định?

Answer 1

Quy ước của tôi không được sử dụng chúng.

Nếu bạn thấy lớp học của mình quá lớn đến mức bạn cần phải ẩn các phần lớn của nó qua các khu vực, tôi đề xuất lớp học của bạn quá phức tạp và nên tách rời nhau.

Answer 2

Có người đã từng nói rằng có một quy ước như trên:

• Private Fields
• Constructors
• Lớp Thuộc tính
• Event Handlers
• vv ...

cũng giống như đặt một bảng nơi tất cả các tấm được với nhau, tất cả các thìa được với nhau, tất cả các dao được với nhau và tất cả các dĩa được với nhau.

Sự cố của tôi đối với vấn đề #region là đặt các phương thức liên quan, định nghĩa sự kiện và thuộc tính cùng nhau trong một khu vực. Tuy nhiên, phải làm điều này ở tất cả sẽ chỉ ra một mùi mã (hoặc là lớp của bạn là quá lớn hoặc không quá nhiều thứ) nhưng đây là một bước đầu tiên tốt để tái cấu trúc nó vào một lớp tốt hơn.

Answer 3

Bạn có thể quan tâm đến điều này do you say no to c# regions.

Tôi nghĩ rằng miễn là bạn nhất quán trong suốt dự án của bạn, nó không quan trọng quá nhiều thứ tự bạn viết chúng. Cũng rất rất thận trọng khi lạm dụng chúng (do đó liên kết ban đầu!).

Không có gì tệ hơn việc tìm một khu vực nhà xây dựng kín đang ẩn chỉ một dòng mã.

Tôi nghĩ rằng cuối cùng nó thuộc về sở thích cá nhân. Như tôi đã nói, tính nhất quán là chìa khóa!

Answer 4

Hãy coi chúng như một dạng nhận xét khác: thông tin bổ sung được trộn lẫn với mã của bạn, có không có kiểm tra chính thức nào được thực hiện trên đó. Do đó nó có khả năng sẽ trôi ra khỏi ngày với mã.

Vì vậy, KHÔNG BAO GIỜ trùng lặp trong các nhận xét hoặc chỉ thị khu vực đã được nêu trong mã.

Chỉ thêm thông tin bổ sung.

Đặc biệt, sử dụng các vùng để phục hồi sự thật là các thành viên nhất định là tài sản, sự kiện, v.v. là hoàn toàn vô nghĩa. Vấn đề thường gặp nhất là bạn tạo một vùng cho "các phương thức riêng", và sau đó bạn chỉnh sửa một trong số chúng để công khai nó. Bây giờ bạn phải di chuyển nó, có nghĩa là trong một khác biệt với phiên bản cũ, sự thay đổi đơn giản là khó khăn hơn nhiều để phân biệt.

Answer 5

#region Lotsa boring code and lookup tables 

tôi sử dụng nó để tiết kiệm màn hình bất động sản, không có gì khác :)

Answer 6

Bất cứ khi nào tôi thấy khu vực tôi nghĩ rằng mã hoặc là tạo ra hoặc có nhu cầu tái bao thanh toán.

Tránh sử dụng chúng và khi bạn cảm thấy cần thiết cho chúng, kiểm tra lại những gì bạn đang làm và cố gắng chia lớp học của bạn thành những lớp nhỏ hơn. Cuối cùng điều này sẽ giúp với khả năng đọc của ứng dụng nhiều hơn sử dụng các vùng sẽ.

Answer 7

tôi đã viết đoạn mã vùng của riêng tôi cho VS 2008 mà tôi luôn luôn sử dụng:

<?xml version="1.0" encoding="utf-8" ?> 
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
<CodeSnippet Format="1.0.0"> 
    <Header> 
     <Title>#class region</Title> 
     <Shortcut>#classregion</Shortcut> 
     <Description>Code snippet for #region in classes</Description> 
     <Author>Simon Linder</Author> 
     <SnippetTypes> 
      <SnippetType>Expansion</SnippetType> 
      <SnippetType>SurroundsWith</SnippetType> 
     </SnippetTypes> 
    </Header> 
    <Snippet> 
     <Declarations> 
      <Literal> 
       <ID>name</ID> 
       <ToolTip>Region name</ToolTip> 
       <Default>MyRegion</Default> 
      </Literal> 
     </Declarations> 
     <Code Language="csharp"> 
      <![CDATA[#region Variables 
        $selected$ $end$ 
       #endregion 

      #region Construction/Destruction 
        $selected$ $end$ 
       #endregion 

      #region Properties 
        $selected$ $end$ 
       #endregion 

      #region Public Methods 
        $selected$ $end$ 
       #endregion 

      #region Private/Proteced Methods 
        $selected$ $end$ 
       #endregion]]> 
     </Code> 
    </Snippet> 
</CodeSnippet> 

Như bạn có thể thấy tôi sử dụng các khu vực cho Variables, Construction/Destruction, Properties, Public và Private phương pháp. Tôi thường thêm một tiểu vùng khác vào khu vực riêng được gọi là events. Thứ tự các khu vực cũng hoạt động tốt với StyleCop.

Answer 8

Cá nhân tôi không khuyên bạn nên tạo các vùng mã trong quy ước mã của bạn. Lý do chính là rằng vùng ẩn mã, mà có thể dẫn đến các vấn đề như:

Developers

• có thể bỏ lỡ một số quan trọng một phần của mã nguồn
• trung bình lượng LỘC trong cùng một tập tin có xu hướng để tăng

Nếu bạn quan tâm đến việc thực thi quy ước kiểu mã trong nhóm của bạn, hãy xem Microsoft StyleCop. Lưu ý rằng công cụ hiện chỉ hoạt động với C#.

Answer 9

tôi sử dụng các khu vực sau:

Private Member Variables 
Constructor 
Public Properties 
Private Methods 
Public Methods 
Events 

Lý do là vì tổ chức tốt hơn mã.
Tôi làm việc với các tệp có thể có hơn 2000 dòng mã và rất khó duy trì mã không có vùng.

Answer 10

Tôi nghĩ rằng không cần thiết ở các khu vực. Chúng không rõ ràng. Nếu bạn cần (suy nghĩ, bạn thực sự cần?) Một mã số tiền trong lớp học của bạn, bạn có thể sử dụng lớp 'một phần' để chia các đơn vị logic lớp.