Coding Philosophy


Coding Philosophy/Goals/Mindset:

Achieve business and technical requirements
  • Agility means these may change as the environment changes, or coding realities drive changes upstream
    • We must adapt to these changes
  • Consider those (including yourself) who will be reading/modifying the code :
    • Extensibility
      • How easily can new features be added?
    • Readability
      • Includes formatting, proper ID naming, and good quality comments--not too many
    • Maintainability
      • How easy will it be to make changes to this code?
    • Scalability
      • What about growth?  For example, another server, or database may be required
  • Efficiency
    • Especially for larger projects, it is important to minimize resource consumption
  • Project velocity
    • While subordinate to the above and within the bounds of efficiency completing quickly/on-time matters
There are many techniques and guidelines for achieving the above such as avoiding magic numbers (use constants) and keeping methods short and single purpose.
References:
---

Comments

Post a Comment

Popular posts from this blog

Spring Boot, parsing the pom.xml

Image
Spring Boot can be easy to start up:options Diving right in letting Spring Boot introductions be covered in another blog.... One way is to navigate to:  https://start.spring.io and find a page like the below: Just select the options then click Generate (not shown).  This will download a zip file which can then be imported easily into your IDE.  I use STS eclipse, after import, the result was: Because I selected Maven, there is a pom.xml file which is instructive.  It includes the necessary dependencies.  I could have specified them on the web page, but I usually just paste them in. Below is the pom.xml file contents from the demo: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelV...
Read more

Java: Reference vs. Object

Image
Declaring and initializing reference variables When learning Java we see reference variables declared and initialized like this: Case A:  ABC varName = new ABC(); Later in our learning, we see something like this: Case B:  ABC varName = new DEF(); Let's take this as an example for discussion: Dthing varName = new Othing(); What is Dthing and what is Othing? From the first chapters of introduction to Java we know that Dthing is the type, and Othing is a constructor, and so is the class of varName. More advanced instruction shows: Dthing is the Declared Type, or Reference Type (I have found them used interchangeably) Othing is the Object Type This vocabulary is needed for reasons including discussion about when to declare/instantiate with the Declared Type being the same as the Object type, and when they should be different. An example of that decision would be in the below. The why is another subject/post: List<String> varStrin...
Read more