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

Chúng tôi đã được yêu cầu thêm nhận xét với thẻ bắt đầu, thẻ kết thúc, mô tả, giải pháp, v.v. cho mỗi thay đổi mà chúng tôi thực hiện đối với mã như là một phần của việc sửa lỗi / thực hiện CR. Mối quan tâm của tôi …

42 version-control  bug  comments  change 

Có phải là một thực hành tốt để đặt số lỗi trong chính tệp trong một nhận xét tiêu đề? Các ý kiến ​​sẽ trông giống như thế này: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 …

40 version-control  development-process  source-code  comments 

Tôi liên tục thấy mọi người đưa ra tuyên bố rằng "các bình luận có xu hướng trở nên lỗi thời". Vấn đề là, tôi nghĩ rằng tôi đã thấy có thể hai hoặc ba bình luận lỗi thời trong toàn bộ sự nghiệp của tôi. Thông tin lỗi thời …

38 comments  myth 

Trong suốt quá trình lập trình, bạn sẽ kết thúc với một số bình luận giải thích mã và một số bình luận đang xóa mã: // A concise description const a = Boolean(obj); //b = false; Có một phương pháp tốt để nhanh chóng phân tích đó là cái …

38 javascript  comments 

Giả sử một bình luận sẽ không phù hợp (hoặc không thể đi) trên dòng mà nó áp dụng, nên viết bình luận trước mã hay sau? Vâng, bất cứ nơi nào độc giả trong tương lai sẽ hiểu rõ nhất phạm vi bình luận. Nói cách khác, bất cứ …

34 comments 

Làm thế nào là ý kiến ​​thường được đối xử trong ngôn ngữ lập trình và đánh dấu? Tôi đang viết một trình phân tích cú pháp cho một số ngôn ngữ đánh dấu tùy chỉnh và muốn tuân theo nguyên tắc ít gây ngạc nhiên nhất , vì vậy …

31 parsing  comments 

Có một hướng dẫn dứt khoát để viết bình luận mã, nhằm vào các nhà phát triển vừa chớm nở? Lý tưởng nhất, nó sẽ bao gồm khi các bình luận nên (và không nên) được sử dụng, và những bình luận nào nên chứa. Câu trả lời này : …

27 language-agnostic  comments 

Tôi thấy điều này được hỏi trong SO Tavern , vì vậy tôi đang đăng câu hỏi ở đây. Tôi nghĩ đó là một câu hỏi thú vị. (Tất nhiên nó không thuộc về SO, nhưng tôi nghĩ nó ổn ở đây.) Bạn có thêm dấu chấm (hoặc, như OP …

27 source-code  comments  coding-style  grammar 

Tôi muốn nghe từ bạn bất kỳ lời khuyên và kinh nghiệm viết bình luận trong mã của bạn. Làm thế nào để bạn viết chúng theo cách dễ dàng và nhiều thông tin nhất? Những thói quen nào bạn có khi bình luận các phần của mã? Có thể …

26 coding-style  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 . Đóng …

25 functional-programming  comments 

Nó xuất hiện không chỉ trong một ngôn ngữ mà các bình luận không thể được lồng vào nhau. Bạn có một giải pháp tốt cho vấn đề này? Một cách giải quyết khác trong C / C ++ và Java là chỉ sử dụng nhận xét một dòng nhưng …

23 java  c++  python  c  comments 

Đã khóa . Câu hỏi này bị khóa vì có nhiều bình luận lạc đề. Nó hiện không chấp nhận câu trả lời hoặc tương tác mới. Tôi đã có một tìm kiếm nhưng không tìm thấy những gì tôi đang tìm kiếm, xin vui lòng liên kết với tôi …

22 coding-standards  comments 

Bất cứ khi nào tôi phát hiện ra rằng một phần lớn mã của tôi cần phải được thay đổi, vì nó không chính xác hoặc vì nó cần phải được điều chỉnh theo các thay đổi kiến ​​trúc chính được yêu cầu bởi các lý do khác, đây là …

21 anti-patterns  comments 

Câu hỏi này đã được di chuyển từ Stack Overflow bởi vì nó có thể được trả lời trên Exchange Engineering Stack Exchange. Di cư 7 năm trước . Bình luận ngày nay dễ dàng hơn bao giờ hết. Trong Java, có một số kỹ thuật hay để liên kết …

20 java  python  clojure  comments 

Từ một số dự án nguồn mở, tôi đã thu thập kiểu mã hóa sau void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Tôi luôn nghi ngờ về những gì falsecó nghĩa là ở đây. Liệu nó có nghĩa là "quên", hay "quên" đề cập đến tham …

19 coding-style  comments  boolean