Boost Maintainability

  • Python basic and Application
  • 2016-08-13 (Sat) 15:40 - 16:20
  • English
  • 102
  • Photography and recording is allowed

Slide

https://speakerdeck.com/mosky/boost-maintainability

Video

https://youtu.be/e7-OQvdSJ1g

PDF

https://github.com/pythonkr/pyconapac-2016-files/raw/master/20160813-102-13-moskyliu.pdf

Description

If we define the maintainability as “to understand a random line, the lines you need to read back”, how do we improve it?


This talk will have three main sections,

  1. Why you should care (5 mins)
  2. Making it zero (20 mins)
  3. Progressive from zero (10 mins)

and finally wish we have a Q&A time.



And the details:


1. Why you should care

It's all about the time

The path when we read the code

Lines you need to read back


2. Making it zero

Simple but dominant rules

  • Be exact and consistent
  • Make it intuitive

Operations hint

  • How it works
  • Explicit unknown
  • Avoid None
  • Content ops
  • Abstract ops

Structure hint

  • For map
  • For tuple
  • When composite

Other hints

  • Return value hint
  • Performance hint
  • Private hint


3. Progressive from zero

Semantic blank lines

  • Learn from lightweight markup language
  • Paragraphing
  • Sectioning

The “wires”

  • Discover the dependencies
  • How messy?

How to face bad smell



Let's boost the maintainability after the talk!

Comments

blog comments powered by Disqus

Sponsors

Keystone

Diamond

Platinum

Gold

Startup

Silver

Media