topic Re: Documentation for a program in SAS Programming

Documentation for a program

Sheeba — Tue, 25 Jul 2017 21:56:18 GMT

Hi,

Is there any way to store the documentation of a program in the same platform?

I am aware of the notes functionality in SAS EG which attaches notes to sas programs. Is there any other way ?

Appreciate any help.

Regards,
Sheeba

Re: Documentation for a program

ballardw — Tue, 25 Jul 2017 22:28:29 GMT

Comments in code are the traditional way. Such as at the top of program a statement of purpose and such:

/*
Program name:
Author:
Last modified date:
Purpose:

Data source:


Analysis questions:


*/

with additional text to describe those elements. Possibly include a change history.

Then at specific code elements you may describe why/what you are doing especially when you find/write code like:

ThisVar = (var2>10)*100 + (Var3<5)*10 + (var4 ne 6);

Re: Documentation for a program

Reeza — Tue, 25 Jul 2017 22:30:22 GMT

Not documentation but you can use GIT or version control software to help. Otherwise, yes, documentation is one thing that doesn't integrate well with code so far 😞

Re: Documentation for a program

Sheeba — Tue, 25 Jul 2017 23:05:51 GMT

Hi Ballardw,

Thanks a lot for the reply.

Yes i have included it in the top of the program and in between the code ..

but i would like to develop a document to explain in detail and move it with code..Think i will have to go with the notes functionality in EG.

Regards,

Sheeba

Re: Documentation for a program

Sheeba — Tue, 25 Jul 2017 23:05:17 GMT

Hi Reeza,

Thanks a lot for the reply.

we are using Git to do the version control but i was looking for some document integration with program...thanks for the details...i will go with the notes functionality in EG.

Regards,

Sheeba