tags:: Software Development

topic:: [[Software Errors]]

softdev:: Unit 3 Outcome 1

- Boundary Value Analysis (BVA)

- a software testing technique that tests the boundaries of a software program's input and output values

- based on the principle that software programs are most likely to fail at the edges of their input and output ranges

- because the code that handles these values is often the most complex and difficult to test

- first identify the input and output ranges of the software program

- then test the program with values at the edges of these ranges, as well as slightly inside and outside of the ranges

- these are the *Boundary Values*

- the maximum and minimum values

- if a software program has an input range of 1 to 100, the tester would test the program with the values 1, 100, 101, and 0

- maximum and minimum acceptable values

- closest invalid values

- particularly useful for testing software programs with complex input and output requirements that require extensive use of {{embed ((6542d358-8f3e-4d79-a58e-6f78d0d070a6)) }}

- tips to perform BVA

- identify the input and output ranges of the software program

- use [[Test Data]] to test the program with values at the edges of these ranges

- as well as outside of the ranges

- test the program with valid and invalid values

- test the program with combinations of valid and invalid values

tags:: Software Development

topic:: [[Programming Concepts]]

softdev:: Unit 3 Outcome 1

- is a type of [[Text file]]

- follows a standard formatting structure that **delimitates** data into rows and columns

- an optional header row can be included as the first row of the file to provide names for columns

- Delimiter

- is the character used to separate data within a row into columns

- commonly a comma or tab, but many systems support any character as the delimiter

- works best with data that maps to a row/column relationship well

- does not work well for data that has a more complex relationship such as parent with multiple children

- no other information is stored in the file to describe the data

- provides a simple method to format a file for data transfer between systems

- does not work well for complex data or data sets containing varied data

- use a [[Truth Table]] to help understand the result of more complex expression involving multiple logical statements

tags:: Software Development

topic:: [[Programming Concepts]]

softdev:: Unit 3 Outcome 1

- the notes and comments written by a programmer within the code itself

- includes information about the program as a whole, including

- about each of the classes, methods, objects, algorithms, etc. within it

- combined with using a [[Naming Convention]] to include well-named variables to create understandable and maintainable code

- has no impact on the compilation or running of the code

- extensive documentation may increase storage size for source code, but is usually negligable

- exists only to provide context and important information about the code

- most useful when a programmer is reading through code that they did not write themselves, or that was written in the past

- relying on memory alone or on interpreting complex algorithms to understand what code is doing is hard work

- saves time

- reduces developer effort

- more efficiently creating and maintaining software

- good Internal Documentation practices

- write meaningful internal documentation for your code

- help you and other developers understand how the code works

- include

- file header comments

- documentation of classes and methods

- function and subroutine comments

- single-line and multi-line comments explaining why code is written this way such as

- to work with another system

- legal requirement constraint

- things that aren't immediately obvious just by looking at the code (background)

- information about testing

- possibly add extra information on upgrades, changes or enhancements made

- [[Version Control]] will also house documentation related to code change

- clear and concise

- avoid jargon or technical terms that are not specific to the software domain

- be specific

- explain less about what code does and more about why it was written this way

- be consistent

- use the same style and format for your internal documentation throughout your code

- follow standard documentation conventions for the programming language

- keep it up to date

- if the code changes, the documentation must be checked and updated as well, if needed

-

-

tags:: Software Development

topic:: Search Algorithms

softdev:: Unit 3 Outcome 1

- the simplest type of search

- checks every element of the input for a match in order until a match is found of the end of the input is reached

- usually completed using [[Iteration]] with a For loop style of [[Processing Feature/Iteration]]

- inefficient as the size of the input grows

- can be useful when input sizes are known to be small

- unlike [[Binary Search]], the input is not required to be sorted first before searching

- ```

```

tags:: Software Development

topic:: [[Programming Concepts]]

softdev:: Unit 3 Outcome 1

- a set of rules followed when creating variables and objects in source code

- provides consistency and clarity to developers

- can add meaning to objects not instantly identifiable otherwise

- often used to provide information about the purpose of the object

- can be used to inform about the object's data type or structure

- many programming languages have conventions about naming conventions

- how to use them for various different objects

- Python's naming conventions are listed in [PEP 8](https://peps.python.org/pep-0008/#naming-conventions)

- aim is to make code easier to read and understand

- Camel Case

- words are combined without spaces

- each word after the first is capitalized

- long names should be avoided

- allows for some meaning to be provided to the object with its name

- readInputFromFile

- Snake Case

- words are combined with an underscore (_)

- all lowercase and underscores instead of spaces

- may be easier for humans to read the words

- read_input_from_file

- Hungarian Notation

- words are combined without spaces

- each word after the first is capitalized

- adds a *prefix* to the beginning of the name

- a combination of lowercase letters

- indicate the [[Data Type]] or [[Data Structure]] of the object

- fnReadInputFromFile returns a value to strFileContents

- can lead to inconsistency when code is changed (refactored)

- not as commonly used in modern software development

tags:: Software Development

topic:: [[Processing Feature]]

softdev:: Unit 3 Outcome 1

- an object-oriented programming feature only supported in languages that support OOP

- a programmer defined representation of an *object* in code

- can store both variables and subroutines ( **methods** ) as part of the class definition

- {{embed ((65421482-6808-45d6-a8c2-6cf29d278c75))}}

- can be extended and represent a relationship between multiple class types using subclasses

- implements the principles of [[Abstraction]], [[Modularity]] and [[Encapsulation]]

tags:: Software Development

topic:: [[Processing Feature]]

softdev:: Unit 3 Outcome 1

- a named [[Processing Feature/Sequence]] of [[Processing Feature/Instruction]]s

- a generic term used by programmers to describe the structure that stores a block of code and can be executed by calling it by name

- can have **parameters** specified in the function declaration which allow for values and objects to be made available to the functions statements when it is executed ( **arguments** )

- these arguments are assigned to temporary variables when the function is called and are *local* to the function

- they don't exist outside the function

- different languages pass data into functions in different ways using as arguments

- by reference

- the original data will be modified if it is changed during the function's execution

- by value

- the original data is not changed during the function's execution

- languages often allow functions to have access restrictions

- depends on the language implementation

- Private

- Public

- Protected

- Subroutine

- a general name for a structure that stores a block of statements and can be executed with a call using its name

- Function

- a subroutine that returns a value when executed

- Procedure

- a subroutine that doesn't return a value when executed

- Method

id:: 65421482-6808-45d6-a8c2-6cf29d278c75

- a function or procedure that is part of an object ( belongs to a [[Processing Feature/Class]] )

- Class Method

- is shared by all objects of the same class

- can be called without an instance object by using the generic class type object

- Instance Method

- is defined in the class type

- can only be called on an object instance of the class

- {{embed ((6540dff6-8035-491b-a86d-536b2812bfe7))}}

-

tags:: Software Development

topic:: [[Processing Feature]]

softdev:: Unit 3 Outcome 1

- a line of code executed to perform an action

- can *define* a value into a variable, known as *assigning* the value to the variable

- can *state* the code to be executed on a line

- some instructions can appear to cover multiple lines of source code, but they are one statement that will be executed as the instruction by the compiler or interpreter