1
Documenting Your Project
2
Documenting your Project
Insert Banner Comments in your code Comment - coding statement used by humans not
the compiler or interpreter Each organization may have different
requirements, check with your instructor Explain purpose of each major section See example on next slide
3
Banner Comments
‘*************************************
‘ Programmer: Carlotta Eaton
‘ Date: June 30, 1998
‘ Source: Hello World.vbp
‘ ID: Chapter 2 Hands-On 1
‘ Purpose: Practice steps to create
‘ a Visual Basic project
‘ Inputs: None
‘ Returns: None
‘***************************************
4
Documenting Your Project
Follow Code Conventions, and Print your Code Conventions make your code easier to read and
understand Use block indenting Print code and put in documentation folder
5
Distributing Your Project
Remove all bugs first Create an executable file
Pull down File menu, and select Make Project exe command or
Use Package and Deployment Wizard (previously called Setup Wizard)
6
Document and Distribute Your First Application
Hands-On Exercise 3 (p.73-78) Open the Hello World Project Add Banner Comments Add Procedure Comments Save and Run the Project Print the Project Make an EXE file Test your Executable Project
7
Summary ...
Key terms defined such as compiler and executable file
Use a systematic process to create a Visual Basic project
Spend more time planning and designing and less time writing, testing and debugging
8
SummaryStep-by-Step Process
1. Define the problem
2. Design and Plan the Solution
3. Build the Program
4. Run the Program
5. Test and Debug
6. Document your project
7. Compile and Distribute
9
Practice with Visual Basic
1. Birthday Card (p.81)
2. Package and Deployment Wizard (p.83)
10
Case Studies
Special Occasion Card The Development Exchange Visual Basic Newsgroups Visual Basic Coding Conventions
11
End of Lecture