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

Rất nhiều người cho rằng "các bình luận nên giải thích" tại sao ", nhưng không phải" làm thế nào "". Những người khác nói rằng "mã nên tự viết tài liệu" và ý kiến ​​nên khan hiếm. Robert C. Martin tuyên bố rằng (thường đọc lại lời của tôi) …

236 programming-practices  documentation  comments 

Tôi đặc biệt được yêu cầu đưa ra từng dòng (hoặc khi thích hợp - ví dụ: hình ảnh bằng hình ảnh, v.v.) giải thích hoặc bình luận mà ông chủ của tôi muốn có thể đọc và theo dõi. Vì anh ta không phải là lập trình viên, anh …

155 documentation 

Tiêu chuẩn RFC 2606 bảo lưu các tên miền example.org , example.net và example.com cho mục đích được sử dụng làm ví dụ trong tài liệu. Tương đương với số điện thoại (bao gồm mã quốc gia) có thể được sử dụng làm ví dụ, ví dụ: để cung cấp …

112 documentation  standards  help-documentation 

Giả sử rằng tôi đang phát triển một dự án tương đối lớn. Tôi đã ghi lại tất cả các lớp và chức năng của mình với Doxygen, tuy nhiên, tôi có ý tưởng đặt "ghi chú của lập trình viên" vào mỗi tệp mã nguồn. Ý tưởng đằng sau …

104 documentation  large-scale-project 

Trong cuộc họp liên quan đến việc khôi phục SDK của bên thứ ba từ phiên bản mới nhất, lưu ý rằng các nhà phát triển của chúng tôi đã gắn cờ trong lịch sử cam kết rằng phiên bản mới nhất không nên được sử dụng. Một số nhà …

94 version-control  documentation 

Tôi đang làm việc trên một dự án khá lớn và có nhiệm vụ thực hiện một số bản dịch cho nó. Có hàng tấn nhãn chưa được dịch và trong khi tôi đang tìm hiểu mã, tôi đã tìm thấy đoạn mã nhỏ này //TODO translations Điều này khiến …

86 documentation  comments 

Tôi đã viết đoạn mã sau: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Có một dòng nhận xét ở đây. Nhưng tôi nghĩ rằng nó làm …

83 documentation  comments 

Trước hết, trong câu hỏi này, tôi muốn tránh xa cuộc bút chiến về việc nhận xét mã nguồn là tốt hay xấu. Tôi chỉ đang cố gắng để hiểu rõ hơn ý nghĩa của mọi người khi họ nói về những bình luận cho bạn biết TẠI SAO, CÁI …

78 documentation  comments 

Tôi đang thực hiện một dự án ba tháng trước, và rồi đột nhiên một dự án khẩn cấp khác xuất hiện và tôi được yêu cầu chuyển sự chú ý của mình. Bắt đầu từ ngày mai, tôi sẽ quay trở lại dự án cũ. Tôi nhận ra rằng …

72 project-management  documentation 

Tôi dự định rời bỏ công việc hiện tại vì chúng tôi bị khóa sử dụng Blub , với khung Blub dành cho doanh nghiệp và máy chủ web cấp Blub, trên lưu trữ chia sẻ tầm thường. Đồng nghiệp của tôi rất thân thiện và ông chủ của tôi …

66 career-development  documentation 

Tôi hiểu tầm quan trọng của mã tài liệu tốt. Nhưng tôi cũng hiểu tầm quan trọng của mã tự viết tài liệu . Càng dễ đọc trực quan một chức năng cụ thể, chúng ta càng có thể di chuyển nhanh hơn trong quá trình bảo trì phần mềm. …

63 programming-practices  code-quality  documentation 

Tạo tài liệu tự động có thể được thực hiện với nhiều công cụ khác nhau, GhostDoc là một trong những công cụ nổi bật hơn. Tuy nhiên, theo định nghĩa, mọi thứ nó tạo ra đều dư thừa. Nó xem xét tên của các phương thức, các lớp, v.v. …

60 documentation  automation  automatic-programming 

Tôi đang viết tài liệu người dùng (một SOP) liên quan đến các chương trình của bên thứ ba mà tôi đang cố gắng mô tả tốt. Một chương trình như vậy là một máy chủ cung cấp ít dấu hiệu khởi động bên cạnh một đồ họa hiển thị …

59 documentation  component  jargon 

Đôi khi tôi thấy mình trong tình huống khi một phần của mã mà tôi đang viết là (hoặc dường như ) rất rõ ràng rằng tên của nó về cơ bản sẽ được lặp lại như một nhận xét: class Example { /// <summary> /// The location of the …

54 programming-practices  documentation  language-agnostic 

Khi bạn sử dụng các công cụ như jsdocs , nó sẽ tạo các tệp HTML tĩnh và các kiểu của nó trong cơ sở mã của bạn dựa trên các nhận xét trong mã của bạn. Những tệp này nên được kiểm tra vào kho Git hay chúng nên …

49 git  documentation