Cách tốt nhất để chèn các ví dụ mã nguồn vào tài liệu Microsoft Word là gì?

Tôi phải viết một số tài liệu sẽ bao gồm các ví dụ mã nguồn. Một số ví dụ sẽ được viết từ IDE và những ví dụ khác sẽ được viết tại chỗ. Các ví dụ của tôi chủ yếu bằng Java.

Là một người đã quen với LaTeX, làm điều này trong Word là vô cùng đau đớn. Tuy nhiên, tôi bị ràng buộc với Word cho điều này. Các tùy chọn duy nhất tôi đã thấy là:

1. Viết hoặc sao chép vào tài liệu, sau đó sử dụng phông chữ cố định, sắp xếp định dạng và hy vọng rằng Word không viết hoa cho bạn. Không cần phải nói, điều này trông giống như tào lao.
2. Sao chép và dán ảnh chụp màn hình của mã nguồn từ IDE. Ít nhất tôi giữ được màu sắc. Tuy nhiên, nếu tôi thay đổi kích thước phông chữ của mình, tôi sẽ bị rối. Tôi cũng bị lừa qua các ranh giới trang. Và hãy thừa nhận, Word không tuyệt vời trong việc quản lý nhiều hình ảnh trên một tài liệu.
3. Viết HTML (không thực sự là một tùy chọn ở đây)

Có một số cách tốt hơn (và lý tưởng di động) để làm điều này? Có ít nhất một số loại phong cách nguyên văn tương tự như môi trường LaTeX? Có ít nhất một số máy in đẹp mà tôi có thể sao chép và dán như RTF không?

Tôi hoàn toàn ghét và coi thường làm việc miễn phí cho Microsoft, vì sau tất cả hàng tỷ đô la, họ VẪN không có hướng dẫn thích hợp về những thứ như thế này bằng ảnh chụp màn hình trên trang web chết tiệt của họ.

Dù sao, đây là một hướng dẫn nhanh trong Word 2010, sử dụng Notepad ++ để tô màu cú pháp và TextBox có thể được chú thích:

1. Chọn Chèn / Hộp văn bản / Hộp văn bản đơn giản
   
2. Một hộp văn bản mặc định được chèn
   
3. Chuyển sang NPP, chọn ngôn ngữ để tô màu cú pháp cho mã của bạn, đi tới Plugins / NPPExport / Sao chép RTF vào clipboard
   
4. Chuyển về từ và dán vào hộp văn bản - nó có thể quá nhỏ ...
   
5. ... vì vậy bạn có thể phải thay đổi kích thước của nó
   
6. Chọn hộp văn bản, nhấp chuột phải vào nó, sau đó chọn Chèn chú thích ...
   
7. Trong menu Phụ đề, nếu bạn chưa có, hãy nhấp vào Nhãn mới và đặt nhãn mới thành "Mã", nhấp OK ...
   
8. ... sau đó trong hộp thoại Chú thích, chuyển nhãn thành Mã và nhấn OK
   
9. Cuối cùng, nhập chú thích của bạn vào hộp chú thích mới được tạo
   

Gần đây tôi đã xem qua bài đăng này và tìm thấy một số gợi ý hữu ích. Tuy nhiên, cuối cùng tôi đã sử dụng một cách tiếp cận hoàn toàn khác phù hợp với nhu cầu của mình. Tôi đang chia sẻ cách tiếp cận và lý do của tôi về lý do tại sao tôi chọn phương pháp này. Bài viết dài hơn tôi muốn, nhưng tôi tin rằng ảnh chụp màn hình luôn hữu ích. Hy vọng, câu trả lời sẽ hữu ích cho ai đó.

Yêu cầu của tôi là như sau:

1. Thêm đoạn mã vào một tài liệu từ, với đánh dấu cú pháp để dễ nhìn và phân biệt mã và văn bản khác.
2. Đoạn mã sẽ được nội tuyến với văn bản khác.
3. Đoạn mã sẽ vượt qua các trang một cách trơn tru mà không cần thêm bất kỳ nỗ lực nào.
4. Đoạn mã sẽ có một đường viền đẹp.
5. Đoạn mã sẽ bị vô hiệu hóa kiểm tra chính tả.

Cách tiếp cận của tôi được liệt kê dưới đây:

1. Sử dụng công cụ bên ngoài để đạt được yêu cầu tô sáng cú pháp 1 ở trên. Người ta có thể sử dụng notepad plus plus như mô tả ở trên. Tuy nhiên, tôi sử dụng công cụ có mặt ở đây - http://www.planetb.ca/syntax-highlight-word . Điều này cho tôi tùy chọn sử dụng số dòng, cũng như tô sáng cú pháp rất hay (Vui lòng sử dụng Google Chrome cho bước này, vì tô sáng cú pháp không được sao chép khi sử dụng Mozilla Firefox, cũng được chỉ ra bởi một số nhận xét của người dùng). Các bước để đạt được cú pháp tô sáng được liệt kê dưới đây:
   • Mở trang web được cung cấp ở trên bằng chrome và Sao chép đoạn mã trong vùng văn bản. Tôi sẽ sử dụng một XML mẫu để chứng minh điều này (mẫu XML từ đây - http: //www.service-arch architecture.com/articles/object-oriented-database/xml_file_for_complex_data.html ).
   • Chọn ngôn ngữ từ menu thả xuống.
   • Nhấp vào nút "Hiển thị đánh dấu". Nó sẽ mở một tab mới, với đoạn mã được tô sáng theo cú pháp, trong trường hợp này là mẫu XML mà chúng tôi đã chọn. Xem hình ảnh dưới đây ví dụ.
   • Để tắt số dòng, kiểm tra trang bằng chrome. Sau đó, theo kiểu, bỏ chọn thuộc tính "lề" trong ".dp-highlighter ol", như trong hình bên dưới. Nếu bạn muốn giữ số dòng, hãy đến bước tiếp theo.
   • Chọn mã được đánh dấu cú pháp và nhấp vào sao chép. Bây giờ mã của bạn đã sẵn sàng để dán vào Microsoft word. Cảm ơn blog này đã cung cấp thông tin này - http://idratherbewriting.com/2013/04/04/adding-syntax-highlighting-to-code-examples-online-and-in-microsoft-word/ .

2. Để đạt được các yêu cầu 2, 3 và 4 ở trên, hãy sử dụng bảng trong Microsoft word, để chèn đoạn mã. Các bước được liệt kê dưới đây:

   • Chèn một bảng với cột đơn.
   • Dán văn bản đã sao chép từ bước 1. trong cột bảng. Tôi đã giữ các số dòng để cho thấy điều này hoạt động tốt như thế nào với Microsoft word.
   • Áp dụng đường viền, như bạn muốn. Tôi đã sử dụng kích thước 1pt. Kết quả đoạn từ Microsoft sẽ xuất hiện như được hiển thị trong ảnh chụp màn hình bên dưới. Lưu ý cách nó phá vỡ độc đáo trên trang - KHÔNG cần thêm nỗ lực để quản lý việc này, điều mà bạn sẽ phải đối mặt nếu chèn đối tượng "OpenDocument Text" hoặc nếu sử dụng "Simple TextBox".

3. Để đạt được yêu cầu 5, hãy làm theo các bước dưới đây:

   • Chọn toàn bộ bảng hoặc văn bản.
   • Chuyển đến tab Xem lại. Trong Ngôn ngữ, chọn "Ngôn ngữ chứng minh". Một cửa sổ bật lên mới sẽ được trình bày.
   • Chọn "Không kiểm tra chính tả hoặc ngữ pháp". Sau đó, bấm OK.
   • Văn bản kết quả đã vô hiệu hóa kiểm tra chính tả. Kết quả cuối cùng được hiển thị trong hình dưới đây và đáp ứng tất cả các yêu cầu.

Vui lòng cung cấp nếu bạn có bất kỳ phản hồi hoặc cải tiến hoặc gặp phải bất kỳ vấn đề nào với cách tiếp cận.

Bạn cần xác định một kiểu trong tài liệu Word của bạn và sử dụng kiểu đó cho mã nguồn. Tôi thường có một kiểu gọi là "Mã" có phông chữ đơn cách ở kích thước điểm nhỏ, các tab kích thước cố định, khoảng cách dòng đơn, không có khoảng cách trước / sau đoạn văn, v.v. Bạn chỉ cần xác định kiểu này một lần rồi sử dụng lại. Bạn dán mã nguồn của mình và áp dụng kiểu "Mã" cho nó.

Lưu ý rằng một số trình soạn thảo (ví dụ Xcode trên Mac) thêm RTF cũng như văn bản vào bảng tạm khi sao chép / dán giữa các ứng dụng - Word nhận ra RTF và giữ lại định dạng, tô màu cú pháp, v.v.

Mã nguồn trong Xcode:

Sao chép và dán vào Word:

(Lưu ý: nên tắt tính năng kiểm tra chính tả theo kiểu "Mã" trong Word.)

Nó phụ thuộc vào IDE. Ví dụ, cả Visual Studio và Eclipse sẽ cho phép bạn sao chép dưới dạng RTF và dán vào Word, giữ tất cả định dạng của bạn.

Notepad ++ có một plugin có tên là "NppExport" (được cài đặt sẵn) cho phép bạn sao chép vào RTF, mặc dù tôi không quan tâm lắm đến việc làm nổi bật cú pháp của Notepad ++ (mặc dù chắc chắn nó có thể qua được). Những gì nó làm là hỗ trợ hàng tá ngôn ngữ, trong khi các IDE đã nói ở trên chỉ giới hạn ở một số ngôn ngữ (không có các plugin khác).

Điều này có liên quan đến câu trả lời này: https://stackoverflow.com/a/2653406/931265 Tạo một đối tượng giải quyết tất cả các vấn đề của tôi.

Chèn> Đối tượng> Văn bản Opendocument

Điều này sẽ mở một cửa sổ tài liệu, dán văn bản của bạn, định dạng nó theo cách bạn muốn và đóng nó.

Kết quả là một con số. Nhấp chuột phải vào đối tượng và chọn 'thêm chú thích'.

Bây giờ bạn có thể tạo các tham chiếu chéo, tạo một bảng số liệu.

Trên máy Mac, tôi thấy giải pháp này với vim là tuyệt vời:

https://github.com/zerowidth/vim-copy-as-rtf

Bạn có thể sử dụng Open Xml Sdk cho việc này. Nếu bạn có mã bằng html với màu sắc và định dạng. Bạn có thể sử dụng altchunks để thêm nó vào các tài liệu từ. Tham khảo bài đăng này Thêm Chuỗi HTML vào Tài liệu OpenXML (* .docx) Hy vọng điều này sẽ giúp!

Đây là những gì tôi đã làm.

Kết quả cuối cùng:

https://stackoverflow.com/a/25092977/1161594

Bạn có thể sử dụng Plugin Syntax Highlight trong Ms.Word https://store.office.com/syntax-highlighter-WA104315019.aspx?assetid=WA104315019 . tôi làm theo bước đó và nó hoạt động

Nếu bạn vẫn đang tìm kiếm một cách đơn giản để thêm đoạn mã.

bạn có thể dễ dàng đi đến [Chèn]> [Đối tượng]> [Văn bản Opendocument]> dán mã của bạn> Lưu và Đóng.

Bạn cũng có thể đặt cái này vào một macro và thêm nó vào thanh truy cập dễ dàng của bạn.

ghi chú:

• Điều này sẽ chỉ mất tối đa một trang mã.
• Mã của bạn sẽ không được tự động sửa .
• Bạn chỉ có thể tương tác với nó bằng cách nhấp đúp vào nó.

Trong Word, có thể dán mã sử dụng màu để phân biệt các nhận xét với mã bằng cách sử dụng "Dán giữ định dạng nguồn." Tuy nhiên, nếu bạn sử dụng mã được dán để tạo kiểu mới, Word sẽ tự động loại bỏ văn bản được mã hóa màu và thay đổi chúng thành màu đen (hoặc bất kể màu mặc định tự động là gì). Vì áp dụng một kiểu là cách tốt nhất để đảm bảo tuân thủ các yêu cầu định dạng tài liệu, Word không hữu ích lắm cho việc lập tài liệu cho các chương trình phần mềm. Thật không may, tôi không nhớ Open Office trở nên tốt hơn. Cách giải quyết tốt nhất là sử dụng hộp văn bản đơn giản mặc định.

Tôi đã thử tất cả các phương thức của bạn, nhưng chúng không hiệu quả với tôi, thực tế tôi đã tạo ra một phương pháp dễ dàng hơn bằng cách sử dụng Bảng MS Word .

Ưu điểm:

1. Đẹp hơn
2. Dễ quản lý & nhất quán hơn
3. Ít gặp vấn đề
4. Không cần plugin bên ngoài hoặc mã hóa vi mô MS Word.
5. Dễ dàng xử lý hơn bởi những người dùng đơn giản ( như bản thân tôi ).

Nhược điểm: Nó sẽ không duy trì màu mã mặc dù ai đó có thể cải thiện thủ thuật của tôi.

Các bước:

1. Chèn bảng 3x3, trong trường hợp của tôi, tôi luôn làm cho tổng chiều rộng của bảng bằng với chiều rộng của trang miễn phí ( tối thiểu 3 hàng để kiểm tra kiểu bảng ).

2. Sử dụng đường viền vô hình ( tùy chọn " Không biên giới " ) và kích hoạt tùy chọn " Xem đường lưới ". nó nên có khía cạnh này Hãy lưu ý rằng những dòng đó là để bạn xem lưới của bảng và sẽ không được in.

3. Thực hiện các điều chỉnh về khoảng cách giữa các ô và chiều rộng của cột để có được khía cạnh bạn thích. ( Bạn sẽ phải vào " Thuộc tính bảng " để tinh chỉnh ).

4. Tạo " Kiểu đoạn văn " với tên " Mã " chỉ cho đoạn mã của bạn ( kiểm tra https://stackoverflow.com/a/25092977/8533804 để có ý tưởng, bạn không phải tuân theo tất cả ý tưởng đó)

5. Tạo một " Kiểu đoạn văn " khác với tên " Code_numberline " sẽ dựa trên kiểu đã tạo trước đó.

6. Trong " Code_numberline " mới được tạo, thêm kiểu đánh số mà bạn thích (điều này sẽ tự động đánh số dòng).

7. Áp dụng " Code_numberline " cho cột đầu tiên và " Code " cho cột 3.

8. Thêm một điền vào cột giữa.

9. Lưu kiểu bàn đó và tận hưởng!

Sử dụng cái này - http://hilite.me/

hilite.me chuyển đổi các đoạn mã của bạn thành định dạng HTML được in đẹp, có thể dễ dàng nhúng vào các bài đăng trên blog, email và trang web.

Cách thực hiện: Chỉ cần sao chép mã nguồn vào khung bên trái, chọn ngôn ngữ và bảng màu và nhấp vào "Đánh dấu!". Bây giờ có thể dán HTML từ khung bên phải vào blog hoặc email của bạn, không yêu cầu tệp CSS hoặc Javascript bên ngoài.

Đối với tài liệu Microsoft Word: Sao chép nội dung từ phần Xem trước và dán vào tài liệu Microsoft Word của bạn.

3 phần: Mã nguồn, HTML và Xem trước

Có một cách dễ dàng nếu bạn muốn định dạng mã đơn giản.

1. Mở từ> Chèn tab> bấm vào "Nhận bổ trợ"
2. tìm kiếm "Trình trộn nội dung" 3.nhấp vào "Thêm"

Sau đó, trình trộn nội dung add sẽ tự động mở và bạn có thể sao chép dán mã của mình vào đó và nhấp vào "Chèn" để chèn nó vào tài liệu word.

Những câu trả lời này có vẻ lỗi thời và khá tẻ nhạt so với giải pháp bổ trợ web; có sẵn cho các sản phẩm kể từ Office 2013.

Tôi đang sử dụng Easy Code Formatter , cho phép bạn mã hóa văn bản tại chỗ. Nó cũng cung cấp cho bạn các tùy chọn đánh số dòng, tô sáng, các kiểu khác nhau và các kiểu được mở nguồn tại đây: https://github.com/armhil/easy-code-formatter-ststyle để bạn có thể tự mở rộng kiểu dáng. Để cài đặt - mở Microsoft Word, hãy chuyển đến Chèn Tab / nhấp vào "Nhận bổ trợ" và tìm kiếm "Trình định dạng mã dễ dàng"