How is version control usually tracked?
Changes are usually identified by a number or letter code, termed the “revision number”, “revision level”, or simply “revision”.
What is the purpose of a version control system?
Revision control allows for the ability to revert a document to a previous revision, which is critical for allowing editors to track each others edits, correct mistakes, and defence against vandalism.
Define Git
Git is a command line client software that supports access to both local and remote repositories.
Define github
GitHub is a web-based Git Repository hosting service
Define Repo
Acronym for a repository - A set of files that are grouped together as a project
What are the six main Git commands? What do they do?
Init - creates Git repo Add - adds in files Commit - the act of adding source code changes to the repo Clone - clones a repo in a new directory (useful for starting a new branch from a remote repo) Checkout - switches branches Merge - merges changes back to the head
What is a programming guideline?
A document that describes the best practices for a particular programming language or technology that guides a programmer to produce a program that can easily be understood by others using the same language or technology
What are the 6 main useful items on a programming guideline?
- naming - general readability - statement order (whether to declare variables at top of block or when needed - general programming rules - comment structure - minimized duplication (dry- refactor code into classes/function)
What are the 3 main types of white box testing?
Peer Review
- general information review process
Walthrough
- More systematic/detailed review of work
- will code meet required specs
- did some aspect of the spec get missed or misunderstood
Inspections
- Fairly formal (review of application of standard/specific guidelines)
eg. systems that may impact human safety
What are data reference errors?
Are the correct variables being used
What are Data Declaration Errors?
Is the correct type being used?
In many cases the compiler (strongly typed) will assist in detecting problems with data type. This can be an issue in loose type programming languages (eg. PHP/JavaScript)
What are Computation Errors?
Is the calculation correct?
Need to verify with another method - Hand, calculator, separate app
How do you check for Comparison?
Are all conditions correct?
Need to be careful when creating multiple condition expressions and when using negative logic
How do oyou check the control of flow?
Check the loops entries and exits
Are the entry and exit conditions for flow control set correctly?
What are parameter errors?
Method input and output
Are the parameters used within a function call correctly specified and is there a verifivation of the values - range checking
How do you check the Application input and output?
Are the data inputs/outputs matched to the appropriate variables?
What are the four different comment types that should be included in newly developed software?
- Overall Desctiptive
- Code Explanation
- Documentation
- Domain / Business
What should be contained in overall / descriptive comments?
- What does the module / component accomplish at a high level
- typically at the top of a module
What should be contained in code explaining comments?
- Details on “non-trivial” code that may be unclear to a junior level programmer within that environment.
- well-written code should be someone self-explanatory.
What should be contained in documentation comments?
- Extractable comments by programming tools
- JavaDoc - Jave
- Sandcastle - .NET
- Doxygen - Open source, many languages
- HeaderDoc - Apple
- Description of how class/method should be called and expectation of parameter values
What should be contained in the Domain / Business Comments?
- Explains the business rules that have been implemented in the code, what and why references.
eg.
What are the 6 questions you need to ask about a certain technology?
- Is the language / framework mature?
- Does it have a significant user base
- Will the client specify the technology?
- Will it perform?
- can it be scaled?
- is it portable?
- Does the technology have:
- Programming Guidelines?
- Quality processes/tools to assist in testing?
What are the two main Questions to ask when trying to choose the right technology?
- Does the client require a specific technology?
- Client / Team may have experience / training in only specific technologies.
- Does the development team:
- Have training in the technology
- Have previously successfully deployed technology in an existing solution similar to the solution being proposed.
- Use best practices to maintain the code
- Source Code Control
- Coding Best Practices’
- Have the ability to hire people well versed in the technology (full-time or contract)
Benefits of commenting?
It is important to leave behind proper communication for new eyes, or even your own eyes at a later date to speed up maintenance of the code which is inevitable.
