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

Tại sao tài liệu về một số ngôn ngữ nói "tương đương" thay vì "là"? Ví dụ: Tài liệu Python nói itertools.chain(*iterables) ... Tương đương với: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Hoặc tài …

23 c++  python  documentation  compiler 

Đã đóng cửa . Câu hỏi này cần được tập trung hơ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 để nó chỉ tập trung vào một vấn đề bằng cách chỉnh sửa bài đăng này . Đóng …

22 documentation  code-reviews  documentation-generation  help-documentation 

Có vẻ như một chủ đề gây tranh cãi để ghi lại tất cả mọi thứ, bao gồm cú pháp "JavaBean" của các getters và setters cho các trường: Mọi người nói rằng việc phá vỡ DRY lâu dài và lặp đi lặp lại (không lặp lại chính mình) , …

22 documentation 

Tôi không thể đếm số lần tôi đọc các câu lệnh trong 'các bài kiểm tra đơn vị là một nguồn tài liệu rất quan trọng của mã được kiểm tra'. Tôi không phủ nhận họ là sự thật. Nhưng cá nhân tôi chưa bao giờ thấy mình sử dụng …

22 unit-testing  documentation 

Chúng tôi hiện đang viết các thông số kỹ thuật chức năng và kỹ thuật theo định dạng hai cột; tóm tắt câu và chi tiết kỹ thuật. Các chi tiết thường đề cập đến một phụ lục với sơ đồ, thiết kế bố trí ect. Tuy nhiên tôi đang …

21 documentation  specifications  writing 

Bối cảnh: Các cộng tác viên của tôi và tôi đang viết một bài báo cho một tạp chí học thuật. Trong quá trình nghiên cứu, chúng tôi đã viết một chương trình mô phỏng bằng Java. Chúng tôi muốn làm cho chương trình mô phỏng có sẵn miễn phí …

20 java  documentation 

Vì vậy, chúng tôi có một giao diện như vậy /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Gần đây, chúng …

20 c#  documentation  xml  documentation-generation 

Đó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 …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

Đôi khi, mặc dù không thường xuyên, tôi phải đưa logic toán học vào mã của mình. Các khái niệm được sử dụng hầu hết rất đơn giản, nhưng mã kết quả thì không - rất nhiều biến với mục đích không rõ ràng và một số hoạt động với …

19 java  documentation  math 

Gần đây tôi đã làm việc để tái cấu trúc các phần của cơ sở mã mà tôi hiện đang xử lý - không chỉ để hiểu rõ hơn về bản thân mà còn giúp những người khác đang làm việc với mã dễ dàng hơn. Tôi có xu hướng …

18 java  documentation  refactoring  javadocs 

Đã đó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 documentation  wiki 

Giả sử rằng bạn là nhà phát triển duy nhất rời bỏ công việc. Những loại thông tin / tài liệu, bên ngoài mã, bạn nên tạo và để lại phía sau để thay thế? Một câu trả lời rõ ràng là "bất cứ điều gì bạn muốn ở một …

18 documentation  knowledge-transfer 

Tôi đã xem xét cách ghi lại các dự án phần mềm chính thức hơn và tôi đã tìm hiểu về IEEE 830-1998: Thực hành được khuyến nghị cho các yêu cầu kỹ thuật phần mềm . Tuy nhiên, như bạn có thể thấy từ liên kết đó, nó đã …

17 documentation  requirements  standards 

Chúng ta đều đã thấy vô số ví dụ về phần mềm có "yêu cầu hệ thống tối thiểu" như sau: Windows XP / Vista / 7 RAM 1GB Dung lượng 200 MB Làm thế nào những điều này thường được xác định? Rõ ràng đôi khi có những ràng …

17 documentation  requirements  qa 

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