Câu hỏi được gắn thẻ «comments»

Tôi đang tìm kiếm một đề xuất về một thực tiễn tốt nhất cho các nhận xét XML trong C #. Khi bạn tạo một thuộc tính, có vẻ như tài liệu XML dự kiến ​​có dạng sau: /// <summary> /// Gets or sets the ID the uniquely identifies this …

19 c#  .net  programming-practices  comments 

Tôi thấy nhiều số vấn đề từ các bình luận về mã jQuery . (Trên thực tế, có 69 số vấn đề trong mã jQuery.) Tôi nghĩ rằng đó sẽ là một cách thực hành tốt, nhưng tôi chưa bao giờ thấy bất kỳ hướng dẫn nào. Nếu đó là …

18 comments  issue-tracking 

Một số ít làm, nhưng không phải bất kỳ trong số những người nổi tiếng như tôi biết. Có điều gì xấu về ý kiến ​​lồng nhau? Tôi dự định có các bình luận khối lồng trong ngôn ngữ (nhỏ) mà tôi đang làm việc, nhưng tôi muốn biết liệu …

18 language-agnostic  syntax  comments 

Đã đóng cửa . Câu hỏi này dựa trên ý kiến . Nó hiện không chấp nhận câu trả lời. Bạn muốn cải thiện câu hỏi này? Cập nhật câu hỏi để có thể trả lời bằng sự kiện và trích dẫn bằng cách chỉnh sửa bài đăng này . …

18 source-code  comments 

Nhà phát triển cấp cao trong cửa hàng của chúng tôi khẳng định rằng bất cứ khi nào mã được sửa đổi, lập trình viên chịu trách nhiệm nên thêm một nhận xét nội tuyến nêu rõ những gì anh ta đã làm. Những bình luận này thường trông giống …

17 coding-standards  comments 

Một trong những nhà phát triển trong nhóm của tôi tin rằng cần phải viết bình luận javadoc cho MỌI tham số trong chữ ký của phương thức. Tôi không nghĩ rằng điều này là cần thiết và thực tế tôi nghĩ nó thậm chí có thể gây hại. Trước …

17 java  documentation  source-code  comments  maintainability 

Trong một số cơ sở mã, bạn có thể thấy các bình luận nêu rõ những điều như: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Vì vậy, tôi đã có một vài câu hỏi, nhưng tất cả chúng đều liên quan. Bạn có thể đặt liên …

16 comments 

Có được coi là thực hành xấu để ném NotImplementedExceptionmã mà bạn chưa viết? Có thể bình luận TODO sẽ được coi là an toàn hơn?

15 .net  comments  coding  exceptions 

Thật khó để nói những gì đang được hỏi ở đây. Câu hỏi này là mơ hồ, mơ hồ, không đầy đủ, quá rộng, hoặc hùng biện và không thể được trả lời một cách hợp lý trong hình thức hiện tại của nó. Để được trợ giúp làm rõ …

15 comments 

Vì hiện tại, câu hỏi này không phù hợp với định dạng Hỏi & Đáp của chúng tôi. Chúng tôi hy vọng câu trả lời sẽ được hỗ trợ bởi các sự kiện, tài liệu tham khảo hoặc chuyên môn, nhưng câu hỏi này có thể sẽ thu hút tranh …

15 comments 

Xem xét các dấu hiệu xung đột. I E: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Trong trường hợp cụ thể đã thúc đẩy tôi đăng câu hỏi này, thành viên nhóm chịu trách nhiệm vừa hoàn thành việc hợp nhất từ ​​thượng nguồn đến chi …

14 version-control  comments  coding-style 

Tôi viết rất nhiều mã (chủ yếu là c ++ và javascript) chạm vào hình học và đồ họa tính toán và các loại chủ đề đó, vì vậy tôi thấy rằng sơ đồ trực quan là một phần không thể thiếu trong quá trình giải quyết vấn đề. Tôi …

14 productivity  code-reviews  comments  workflows  image-manipulation 

Chúng tôi đang thực hiện một số tái cấu trúc cho một cơ sở mã di sản 20 năm tuổi và tôi đang thảo luận với đồng nghiệp của mình về định dạng nhận xét trong mã (xin vui lòng, java). Không có định dạng mặc định cho các bình …

13 java  c#  programming-practices  code-quality  comments 

Tôi đang tìm định dạng tài liệu lớp thông tin cho các lớp Thực thể, Logic nghiệp vụ và Truy cập dữ liệu của tôi. Tôi tìm thấy sau hai định dạng từ đây Định dạng 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// …

13 c#  documentation  comments 

Đây có phải là phong cách tốt để sử dụng các biến cục bộ bổ sung, kỹ thuật thừa để mô tả những gì đang xảy ra không? Ví dụ: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Khi nói đến chi phí kỹ …

12 coding-style  comments