| 1 | |
| 2 | Program Name : TEMPLATE.sas |
| 3 | Purpose : PURPOSE OF THE MACRO |
| 4 | SAS Version : SAS VERSION WHEN THE MACRO WAS ORIGINALLY WRITTEN |
| 5 | Input Data : N/A |
| 6 | Output Data : N/A |
| 7 | |
| 8 | Macros Called : LIST ANY UTILITY MACROS CALLED BY THIS MACRO |
| 9 | SO THEY CAN BE ADDED TO THE SASAUTOS LIBRARY AS WELL |
| 10 | |
| 11 | Originally Written by : YOUR FULL NAME (NOT INITIALS - MAKE IT EASY TO FIND YOU LATER) |
| 12 | Date : TODAYs DATE IN DDMONYYYY FORMAT (INTERNATIONLALLY UNAMBIGUOUS DATE FORMAT) |
| 13 | Program Version # : 1.0 |
| 14 | |
| 15 | ======================================================================= |
| 16 | |
| 17 | Copyright (c) 2016 Scott Bass (sas_l_739 @yahoo.com.au) |
| 18 | |
| 19 | This code is licensed under the Unlicense license. |
| 20 | For more information, please refer to http://unlicense.org/UNLICENSE. |
| 21 | |
| 22 | ======================================================================= |
| 23 | |
| 24 | Modification History : Original version |
| 25 | |
| 26 | Programmer : YOUR FULL NAME |
| 27 | Date : DDMONYYYY |
| 28 | Change/reason : SUMMARY OF CODE CHANGE. |
| 29 | ADD COMMENTS IN THE CODE ITSELF |
| 30 | (INCLUDING NAME AND DATE) FOR ADDITIONAL DETAILS) |
| 31 | Program Version # : 1.1 |
| 32 | |
| 33 | Programmer : YOUR FULL NAME |
| 34 | Date : DDMONYYYY |
| 35 | Change/reason : SUMMARY OF CODE CHANGE. |
| 36 | ADD COMMENTS IN THE CODE ITSELF |
| 37 | (INCLUDING NAME AND DATE) FOR ADDITIONAL DETAILS) |
| 38 | Program Version # : 1.2 |
| 39 | |
| 40 | VERSION 1.0 (ORIGINAL VERSION): |
| 41 | LEAVE "Original version" TEXT IN PLACE |
| 42 | DELETE REVISION HISTORY |
| 43 | |
| 44 | VERSION 1.1+ (MODIFIED VERSION): |
| 45 | DELETE THE "Original version" TEXT |
| 46 | ADD THE REVISION HISTORY PER ABOVE TEMPLATE |
| 47 | |
| 48 | =====================================================================*/ |
| 49 | |
| 50 | |
| 51 | Usage: |
| 52 | |
| 53 | LIST MACRO USE CASE / UNIT TESTS HERE |
| 54 | TRY TO USE UNIVERSALLY AVAILABLE SOURCE DATA IF POSSIBLE |
| 55 | (EG. SASHELP DATASETS, C:\WINDOWS, /USR/LOCAL, ETC.) |
| 56 | OR ELSE CREATE SIMPLE TEST DATA INLINE |
| 57 | SO THE END USER CAN RUN THE USE CASE WITHOUT FURTHER SETUP OR EFFORT. |
| 58 | IDEALLY THE TEST CASES RUN BY HIGHLIGHTING THE TEXT IN THE SAS EDITOR |
| 59 | AND HITTING F3 |
| 60 | |
| 61 | ======================================================================= |
| 62 | |
| 63 | ADDITIONAL USE CASE |
| 64 | |
| 65 | ======================================================================= |
| 66 | |
| 67 | ADDITIONAL USE CASE |
| 68 | |
| 69 | ----------------------------------------------------------------------- |
| 70 | Notes: |
| 71 | |
| 72 | EXPLANATORY NOTES HERE, THAT EXPLAIN DESIGN DECISIONS OR |
| 73 | GENERAL USAGE INFORMATION. |
| 74 | |
| 75 | THESE ARE NOTES THAT GO BEYOND COMMENTS WITHIN THE MACRO CODE. |
| 76 | |
| 77 | ---------------------------------------------------------------------*/ |
| 78 | |
| 79 | %macro TEMPLATE |
| 80 | |
| 81 | PURPOSE OF THE MACRO (REDUNDANT BUT NICE TO HAVE HERE AS WELL) |
| 82 | ---------------------------------------------------------------------*/ |
| 83 | (PARM1 |
| 84 | ,PARM2=default |
| 85 | ); |
| 86 | |
| 87 | %local macro parmerr _data_; |
| 88 | %let macro = &sysmacroname; |
| 89 | |
| 90 | %* check INPUT parameters ; |
| 91 | %parmv(PARM1, _req=1,_words=1,_case=N) |
| 92 | %parmv(PARM2, _req=0,_words=0,_case=N) |
| 93 | |
| 94 | %IF (&parmerr) %THEN %goto QUIT; |
| 95 | |
| 96 | %* additional error checking ; |
| 97 | %IF (&parm1 eq FOO and %superq(parm2) eq BAR) %THEN %DO; |
| 98 | %parmv(_msg=These two values are mutually exclusive) |
| 99 | %goto %QUIT; |
| 100 | %END; |
| 101 | |
| 102 | %* well commented macro code goes here ; |
| 103 | |
| 104 | %* Use %* or comment style for comments that DO not show in MPRINT OUTPUT ; |
| 105 | %* Use * comment style for comments that show in MPRINT OUTPUT ; |
| 106 | |
| 107 | %QUIT: |
| 108 | |
| 109 | %mend; |
| 110 | |
| 111 | |