16

I need to use MS Word to make some documentation for Python code. Line number, or boxing around the code, or anything would be better than just use normal format.

Is there any good/useful style/method for code documentation purposes?

phuclv
  • 26,555
  • 15
  • 113
  • 235
prosseek
  • 5,794
  • 21
  • 59
  • 78
  • See this popular question on Stack Overflow, https://stackoverflow.com/questions/387453/how-do-you-display-code-snippets-in-ms-word-preserving-format-and-syntax-highlig – scenography Sep 25 '22 at 18:56

5 Answers5

9

At the most basic you can select a monospaced font - usually Courier New - as your code font. You won't get all the syntax highlighting, but it will stand out from the rest of your document.

ChrisF
  • 41,278
  • 17
  • 101
  • 154
6

Do you have an editor that formats python code for you? I ask because Visual Studio will copy code onto the clipboard with formatting intact so that when pasted into word it looks identical (give or take line lengths).

Visual Studio itself supports python now. The Community Edition doesn't have the somewhat restrictive licensing limitations of the old Express edition; meaning it's likely to be an - admittedly heavyweight - option to get formatted code into other documents even if your preferred editor doesn't put syntax highligfhed code onto the clipboard.

2

You need to add Office-addin called Easy Syntax Highlighter

from Insert tab click ... > Add-ins >

search for Easy Syntax Highlighter > Add

It will show as a new tab

Setting > choose your prefered Theme

Personally I like Solarized Light

tijko
  • 314
  • 1
  • 2
  • 9
Hany Afifi
  • 21
  • 3
1

If you manage to copy code style from your IDE, you'll find that the font used for Eclipse IDE (for example) is "Consolas". I find that it looks pretty good in MS Word.

If you require 100% of the formatting you might be able to find an online tool that will do the highlighting for you.

ChrisF
  • 41,278
  • 17
  • 101
  • 154
1

If you have Notepad++ then just select the code then select menu Plugins > NppExport > Copy RTF to clipboard and paste to Word

Notepad copy with format


In VS Code there's a similar feature. Just press Ctrl+Shift+P then search for the "Copy With Syntax Highlighting" command

VS Code copy with syntax highlighting

phuclv
  • 26,555
  • 15
  • 113
  • 235