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

1

loại hệ thống tài liệu kỹ thuật trực tuyến nào bạn muốn giới thiệu? [đóng cửa]

Đã đó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 . …

11 documentation 

---

5

Là một tài liệu mô tả kiến ​​trúc có vi phạm Nguyên tắc DRY không?

Nguyên tắc DRY (Đừng lặp lại chính mình) nói rằng "mỗi phần kiến ​​thức phải có một đại diện duy nhất, rõ ràng, có thẩm quyền trong một hệ thống." Hầu hết thời gian này đề cập đến mã, nhưng nó cũng thường được mở rộng cho tài liệu. Người …

11 agile  documentation  architecture  dry 

---

5

Các mẫu / yêu cầu đề xuất dự án [đã đóng]

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 …

11 project-management  business  management  documentation 

---

4

Thực hành tốt nhất để đánh dấu một phương pháp được gọi thông qua sự phản ánh?

Phần mềm của chúng tôi có một số lớp nên được tìm thấy động thông qua sự phản chiếu. Tất cả các lớp đều có một hàm tạo với một chữ ký cụ thể thông qua đó mã phản chiếu sẽ khởi tạo các đối tượng. Tuy nhiên, khi ai …

11 c#  .net  documentation  reflection 

---

6

Là ý kiến ​​được coi là một hình thức của tài liệu?

Khi tôi viết các tập lệnh nhỏ cho chính mình, tôi xếp chồng mã của mình lên cao bằng các bình luận (đôi khi tôi nhận xét nhiều hơn mã tôi). Rất nhiều người tôi nói để nói rằng tôi nên ghi chép lại các kịch bản này, mặc dù …

11 documentation  comments 

---

3

Viết bình luận tài liệu java cho các trường hợp thử nghiệm đơn vị

Theo tôi, các trường hợp kiểm thử đơn vị tự nó đóng vai trò là tài liệu cho mã. Công ty của tôi muốn tôi viết bình luận tài liệu java chi tiết về các trường hợp thử nghiệm đơn vị. Có cần thiết phải làm như vậy? Bạn có …

11 unit-testing  documentation 

---

4

Bao gồm một liên kết đến tài liệu liên quan trong thông báo lỗi?

Chúng tôi tạo ra một thư viện thương mại và các ví dụ mã đang được sử dụng bởi các nhà phát triển bên ngoài. Chúng tôi có tài liệu (đã đóng, có sẵn cho người dùng đã đăng ký) giải thích rộng rãi cách sử dụng thư viện. Nhiều …

10 documentation  api-design  error-handling  error-messages 

---

4

Có một tiêu chuẩn để ghi lại kiến ​​trúc cấp cao của chương trình không?

Tôi là một nhà phát triển nghiệp dư và tất cả các chương trình của tôi cho đến nay đều đủ đơn giản để được ghi lại trong mã. Trong khi đọc mã, rõ ràng tôi đã làm gì và hành động như vậy (bài kiểm tra tiêu chuẩn của …

10 architecture  documentation 

---

5

Sử dụng các mẫu khác nhau cho các tính năng tương tự

Tôi là nhà phát triển duy nhất trong một dự án, giống như đối với bất kỳ dự án phần mềm nào, có thể được thực hiện bởi người khác trong tương lai. Giả sử tôi đã sử dụng mẫu X để triển khai tính năng A. Sau khi phát …

10 design-patterns  refactoring  documentation 

---

1

Thông tin nào nên có trong github README.md?

Thông tin nào bạn muốn thấy trong github README? Tất cả mọi thứ nên đi trong README? I E Giới thiệu Cài đặt Phiên bản Hướng dẫn sử dụng Thực hiện Kiểm tra Tài nguyên liên quan Hoặc bạn chỉ nên đặt một số thứ nhất định trong README (Giới …

10 documentation  github 

---

3

Nhận xét XML Tài liệu cần thiết?

Tôi đã từng là một người hâm mộ yêu cầu các bình luận XML cho tài liệu. Tôi đã thay đổi suy nghĩ vì hai lý do chính: Giống như mã tốt, phương pháp nên tự giải thích. Trong thực tế, hầu hết các bình luận XML là tiếng ồn …

10 .net  programming-practices  development-process  documentation  comments 

---

5

Có phải là một ý tưởng tốt để viết các yêu cầu kỹ thuật theo câu chuyện?

Hiện tại chúng tôi đang sử dụng các phương thức nhanh trong dự án hiện tại của mình và chúng tôi có rất nhiều câu chuyện như sau: Là một trợ lý, tôi muốn hoàn lại tiền cho khách hàng để họ có thể nhận được một số tiền khi …

10 agile  documentation  requirements  user-story 

---

5

Xác định đúng số lượng tài liệu

Nơi tôi đang làm việc, cách tiếp cận chung là - tránh tài liệu càng nhiều càng tốt Chỉ tài liệu nếu một nhóm khác sẽ cần nó chỉ để làm rõ, tôi không có nghĩa là tài liệu mã - điều này chúng tôi làm, ý tôi là tất …

10 documentation 

---

5

Cách tốt hơn để đào tạo nhân viên mới [đóng cửa]

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

10 documentation  training 

---

5

Một nhận xét phương pháp có nên bao gồm cả mô tả tóm tắt và trả về khi chúng thường giống nhau không?

Tôi là người đề xuất mã tài liệu đúng và tôi nhận thức rõ những nhược điểm có thể có của nó . Đó là ngoài phạm vi của câu hỏi này. Tôi thích tuân theo quy tắc thêm nhận xét XML cho mọi thành viên công cộng, xem xét …

10 documentation  comments  intellisense 

---