Internal and Intrinsic Documentation (1 Viewer)

[honky tonk]

I don't have good definitions of these in my notes, what is the difference between the two? Also, what are some examples of each?

Thanks a bunch.

 

[Winston]

Originally posted by honky tonk
I don't have good definitions of these in my notes, what is the difference between the two? Also, what are some examples of each?

Thanks a bunch.

LOL!! man... how about my teacher continuously said Intrinsic documentation is commenting, and we took that for about 2 yrs, then when i was reading the sam d text book night before trials, i noticed intrinsic, was in relation to how u structure code apparently. for example good indentation. And also it refers to the meaningful variable naming, this falls under the Source code documentation side of things

 

[ezzy85]

Intrinsic documentation is a form of internal documentation. Its referring to using useful variable names, highlighting keywords, anything affecting the actual code. Internal doc is the comments made in the source code.

 

[Ragerunner]

Comments to describe what the code does. Should be used sparingly. Used for complex codes.

Not for codes where you got

PRINT "Hello" `It prints hello

Because it's pretty damn obvious

Intrinsic - Meaningful variables names, Indenting etc.. You know all the stuff that makes the code look easier to read

 

[fatmuscle]

Originally posted by Ragerunner
Intrinsic - Meaningful variables names, Indenting etc.. You know all the stuff that makes the code look easier to read

that's what I thought.

like if you're storing a variable that holds an 'age'

you wouldn't use
int x;

but something more like
int age;

 

[Ragerunner]

Another good one would be using arrays. You don't necesarrily need to index 0-100 if you want to show e.g. rainfall

Instead of

Rainfall(5) = 1000000m

You could have

Rainfall(1995) = 1000000m

In which a meaningful array was used to describe the year.

 

[yorkyorkxp]

Internal Documentation:
Any form of documentation that exits in the code of the program including Intrinsic Documentation and remarks (to help programmers) and Online Documentation (to help users).

Intrisic Documentation:
A form of documentation that exists in normal code because it needs to be there to make the code readable. It includes use of logical variable names, indenting and capitalisation of reserved words.

 

[-X-]

Originally posted by yorkyorkxp
Internal Documentation:
Online Documentation (to help users).

So internal documentation can also mean the help file in the program?

 

[Fosweb]

Is it a help file so much as things like balloon help/tooltips...?

 

[-X-]

No i mean the actual help file were u click on Help > "Help and Support".
Ok so that would be external documentation? And i assume balloon help would be internal? And what about "Online Documentation", shouldn't that be external?

 

[Skywalker]

Originally posted by -X-
No i mean the actual help file were u click on Help > "Help and Support".
Ok so that would be external documentation? And i assume balloon help would be internal? And what about "Online Documentation", shouldn't that be external?

"Help ---> Help and support" is online documentation. Balloon help is not internal, it's also online. External documentation would be user manuals, reference charts etc.

 

[-X-]

But yorkyorkxp is "online documentation" is internal documentation. Read his post.