How to document your code?

_config.yml

Have you ever written some code and then come back to it some six months later and found yourself, expecting to navigate the streets near your abode to get home, only to find yourself in some inhospitable terrain on mars?

Good documentation is vital. And clearly written and well designed code is a part of that, but for now we’ll focus only on documentation.

Here are two tools you need:

  1. SandCastle and
  2. GhostDoc.

Well where do I get Sandcastle and how do I use it

You can get it from here: https://github.com/EWSoftware/SHFB/releases

And if you want to know how to use it – and it’s really quite simple, then watch this video: https://www.youtube.com/watch?v=ONzJWv18xdY – it’s a very, very good tutorial and he does more justice to the topic than I ever could (or will).

Where and how do I get Ghostdoc?

https://marketplace.visualstudio.com/items?itemName=sergeb.GhostDoc

Written on January 22, 2017