Có thể chèn hình ảnh vào nhận xét mã không?

Question

Câu hỏi của tôi có lẽ là một ý tưởng điên rồ, tuy nhiên, nó rất có giá trị khi tôi viết mã cho mục đích giáo dục.

Đặc biệt khi mã có liên quan đến môn toán và vật lý, hình ảnh được chèn vào trong nhận xét thuận tiện hơn và khớp nối hơn.

Cho đến bây giờ, tôi không thể tìm thấy một cách thành công để chèn hình ảnh thực vào nhận xét, không phải C# cũng không python hoặc bất kỳ ngôn ngữ lập trình phổ biến khác hoặc IDE.

Sử dụng các công cụ chuyển đổi hình ảnh thành hình ảnh ASCII là một cách giải quyết ít chính xác hơn.

Bất kỳ ý tưởng nào đều đánh giá cao

Answer 1

Có một ví dụ ở đây là mở rộng Visual Studio 2010 biên tập: Image Insertion (nhưng nó gắn liền với Visual Studio, không phải là một giải pháp chung chung)

Answer 2

Tôi nghĩ bạn đang sử dụng công cụ sai cho sự cố của mình. Một IDE là một môi trường 'phát triển' vì vậy nó không phải là rất quan trọng để có toàn quyền kiểm soát kiểu dáng.

Tôi sẽ sử dụng một cái gì đó khác (như LaTeX, xem nhận xét) cho bạn trình bày.

Answer 3

công cụ Lập trình biết chữ làm việc theo cách này; về cơ bản bạn sử dụng TeX hoặc một cái gì đó để viết mã, sau đó chạy một bộ tiền xử lý để trích xuất các đoạn mã vào một tệp nguồn trung gian. http://en.wikipedia.org/wiki/Literate_programming

Answer 4

Tại sao không sử dụng lưu trữ hình ảnh miễn phí như http://imgur.com và chèn liên kết hình ảnh vào nhận xét mã?

Sau đó, vấn đề duy nhất đối với học sinh là liên kết copypaste đến trình duyệt từ bất kỳ IDE nào. Khá dễ dàng mặc dù.

Có thể một số IDE có khả năng "gạch dưới" liên kết để bạn có thể nhấp vào liên kết thay vì sao chép.

Answer 5

Mỗi dự án SHFB là vùng chứa riêng cho mọi thứ được thấy trong dự án tài liệu. Khi nó được biên dịch, tài liệu XML (của dự án ") được đưa vào SHFB để được đưa vào tài liệu.

Nếu bạn muốn hiển thị hình ảnh trong phần trên cùng của tài liệu lớp học, bạn phải thêm hình ảnh vào SHFB dự án và tham khảo hình ảnh từ những nhận xét đang Xem vấn đề 2 ...

vấn đề 1:.

"tôi không thể có được một hình ảnh để hiển thị từ một chủ đề khái niệm bằng cách sử dụng 'hình ảnh' thẻ "

1. Hãy chắc chắn để sử dụng đánh dấu XML thích hợp tương tự như sau:

   <section> 
       <content>   
       <mediaLink> 
        <image xlink:href="MyMainImage"/> 
       </mediaLink> 
       </content> 
   </section> 
   

2. Chú ý rằng Href (ở trên) không có các loại tập tin liên quan,
   đây là vì Sandcastle muốn các Thay vào đó, hãy nhập ID.

3. Thêm hình ảnh vào dự án bằng thư mục phương tiện mặc định. Hoặc, nếu bạn muốn, bạn có thể tạo thư mục của riêng mình, ví dụ: Hình ảnh.
4. Chuyển đến trang thuộc tính của hình ảnh và đặt Xây dựng tác vụ thành Hình ảnh. Khi bạn sử dụng thẻ "hình ảnh", SHFB chỉ sử dụng ID hình ảnh được tìm thấy trong trang thuộc tính, được thấy trong HREF ở trên.
5. Biên soạn lại dự án và mở tệp CHM và bạn sẽ thấy hình ảnh .

Vấn đề 2:

"Tôi không thể có được một hình ảnh để hiển thị sử dụng Mã cho ý kiến ​​đánh dấu XML trong dự án lập trình".

1. Trong phần tóm tắt các nhận xét mã, đánh dấu có thể trông giống như này:

   /// <summary> 
   /// <remarks><img src="\Images\MyImage.PNG"/></remarks> 
   /// </summary> 
   

2. Lưu ý rằng các thuộc tính src không chứa loại tệp. Nó cũng phải xác định chính xác thư mục mà dự án SHFB của bạn có cho hình ảnh đó.

3. Sau khi thêm hình ảnh đó đến SHFB nhấp chuột phải vào nó và thay đổi "Xây dựng hành động" tài sản để Content

Chúc mừng mã hóa và ghi lại! Nhờ đi vào Eric W.

Keywords: SHFB Không thể Add Image Sandcastle Trợ giúp tập tin Builder Conceptual Topic hình ảnh Mã Images Bình luận tập tin hình ảnh CHM Làm thế nào để thêm một hình ảnh trong Bộ luật XML Bình luận C#