How to Document an Excel App

[pjmorris]

Hi, I've created an App that is fairly complicated and in addition to normal Excel functions uses VBA, PowerQuery and PowerPivot. How do I document it so I can remember how it works when it needs to be updated/amended.

Grateful for advice.

Best Regards

 

[mumps]

You can add comments before, after or at the end of each line of code by starting the comment with an apostrophe. For example:

Sub test()
    Range("A1").Copy 'this line of code copies cell A1
End Sub

 

[pjmorris]

Hi Mumps, though I'm not very good at doing so I am familiar with that approach. I was looking for something more comprehensive as it needs to include understanding how the various tables relate to each other, how the measures in PowerPivot operate etc.

But every bit of advice is appreciated.

Regards

 

[mumps]

As far as I know, that is the only way you can add comments directly into a macro. The only other alternative I can think of is to write up a description in a Word document where you could take one line of code or several lines at time and write a description of how they work and what they do.

 

[pjmorris]

As far as I know, that is the only way you can add comments directly into a macro. The only other alternative I can think of is to write up a description in a Word document where you could take one line of code or several lines at time and write a description of how they work and what they do.

That's what I'm afraid of, but I can't help thinking there must be some Visio/Database type standards or templates that would make it easier. Maybe not? perhaps I need to invent something.

Thanks for the suggestion.

 

[mumps]

My pleasure and good luck with it.

 

[sandy666]

maybe it will help

How to Make a Help File: 10 Steps (with Pictures) - wikiHow

A beginner's guide to writing and editing computer software help filesAlthough frequently ignored by many computer users, help files provide key information about how to use the software application they are associated with. By clicking...

www.wikihow.com

no pain no gain