From 38b2102cc861ce8f5291fce1b8a03257cbf43104 Mon Sep 17 00:00:00 2001 From: HGE6730 <> Date: Thu, 31 Jan 2019 12:13:43 -0600 Subject: [PATCH 1/5] Added mobile-standards section, started addition of mobile alerting --- Mobile-Standards/README.md | 9 + .../mobile-alerting-and-sounds-standard.md | 26 + Mobile-Standards/summary.json | 1 + Mobile-Standards/swift-oop.md | 1064 +++++++++++++++++ 4 files changed, 1100 insertions(+) create mode 100644 Mobile-Standards/README.md create mode 100644 Mobile-Standards/mobile-alerting-and-sounds-standard.md create mode 100644 Mobile-Standards/summary.json create mode 100644 Mobile-Standards/swift-oop.md diff --git a/Mobile-Standards/README.md b/Mobile-Standards/README.md new file mode 100644 index 0000000..af02691 --- /dev/null +++ b/Mobile-Standards/README.md @@ -0,0 +1,9 @@ +# Mobile-Standards +This section describes our standards and best practices related to mobile apps. Our goal is have cohesion across all of HCA's development efforts. + + +| Section | | +|--|--| +|[Styling - Swift Functional](/Code-Standards/swift-functional.md)|Coding style for Swift project following functional| +|[Styling - Swift Object-Oriented](/Code-Standards/swift-oop.md)|Coding style for Swift project following OOP| + diff --git a/Mobile-Standards/mobile-alerting-and-sounds-standard.md b/Mobile-Standards/mobile-alerting-and-sounds-standard.md new file mode 100644 index 0000000..51f9633 --- /dev/null +++ b/Mobile-Standards/mobile-alerting-and-sounds-standard.md @@ -0,0 +1,26 @@ + +# Mobile Alerting and Sounds Standard + +This document is intended to set guidelines and standards on sounds being emitted from mobile devices at HCA. + + +## Non-Clinical Environment + +Sounds introduced into the non-clinical environment should augment the patient/clinician experience not disrupt it. When selecting sounds, one should ensure that it is appropriate for the goal of the sound alert, ringtone, or alarm. The sounds should be in alignment with the following: + +* Sounds should not mimic common emergency sounds or sirens. +* Sounds should be considered professional in nature +* Sounds should be different enough from existing system sounds that they would be unlikely to be confused +* Sounds should be in the WAV 44.1k 16 bit format as it is lossless, is usable by both Windows and Macintosh computers, and can be easily converted into other formats as needed going forward +* Sounds should maximize the available headroom making them as loud as they can be while remaining uniform to the other sounds in the app, without sounding distorted on the device +* For applications that support multiple alert levels, sounds should have different versions that indicate increasing levels of alert + + +## Clinical Environment + +Sounds introduced into the clinical environment should follow the non-clinical standards in addition to the following: + +* Sounds should be different enough from medical equipment alerting sounds that they would be unlikely to be confused +* Sounds should be able to cut through noisy environments +* Sounds should be still be effective when the device is in a pocket +* Haptics should be used in addition to sound diff --git a/Mobile-Standards/summary.json b/Mobile-Standards/summary.json new file mode 100644 index 0000000..ab1a3bd --- /dev/null +++ b/Mobile-Standards/summary.json @@ -0,0 +1 @@ +{"title":"Mobile-Standards","description":"Standards for mobile development."} diff --git a/Mobile-Standards/swift-oop.md b/Mobile-Standards/swift-oop.md new file mode 100644 index 0000000..b1aa5ba --- /dev/null +++ b/Mobile-Standards/swift-oop.md @@ -0,0 +1,1064 @@ + +# Swift (OOP) + +### Updated for Swift 4.2 + +This is out style guide for Swift projects that follow the object oriented programming pattern. It is an adaptation of the Ray Wenderlich style guide. +Our overarching goals are clarity, consistency and brevity, in that order. + +## Table of Contents + +* [Correctness](#correctness) +* [Naming](#naming) +* [Prose](#prose) +* [Delegates](#delegates) +* [Use Type Inferred Context](#use-type-inferred-context) +* [Generics](#generics) +* [Class Prefixes](#class-prefixes) +* [Language](#language) +* [Code Organization](#code-organization) +* [Protocol Conformance](#protocol-conformance) +* [Unused Code](#unused-code) +* [Minimal Imports](#minimal-imports) +* [Spacing](#spacing) +* [Comments](#comments) +* [Classes and Structures](#classes-and-structures) +* [Use of Self](#use-of-self) +* [Protocol Conformance](#protocol-conformance) +* [Computed Properties](#computed-properties) +* [Final](#final) +* [Function Declarations](#function-declarations) +* [Function Calls](#function-calls) +* [Closure Expressions](#closure-expressions) +* [Types](#types) +* [Constants](#constants) +* [Static Methods and Variable Type Properties](#static-methods-and-variable-type-properties) +* [Optionals](#optionals) +* [Lazy Initialization](#lazy-initialization) +* [Type Inference](#type-inference) +* [Syntactic Sugar](#syntactic-sugar) +* [Functions vs Methods](#functions-vs-methods) +* [Memory Management](#memory-management) +* [Extending Lifetime](#extending-lifetime) +* [Access Control](#access-control) +* [Control Flow](#control-flow) +* [Ternary Operator](#ternary-operator) +* [Golden Path](#golden-path) +* [Failing Guards](#failing-guards) +* [Semicolons](#semicolons) +* [Parentheses](#parentheses) +* [Multi-line String Literals](#multi-line-string-literals) +* [No Emoji](#no-emoji) +* [Organization and Bundle Identifier](#organization-and-bundle-identifier) +* [Copyright Statement](#copyright-statement) +* [References](#references) + + +## Correctness + +Make your code compile without warnings. You can modify your projects build settings to treat warnings as errors to prevent any slipping by. This rule informs many style decisions such as using `#selector` types instead of string literals. + +## Naming + +Descriptive and consistent naming makes software easier to read and understand. Use the Swift naming conventions described in the [API Design Guidelines](https://swift.org/documentation/api-design-guidelines/). Some key takeaways include: + +- striving for clarity at the call site +- prioritizing clarity over brevity +- using camel case (not snake case) +- using uppercase for types (and protocols), lowercase for everything else +- including all needed words while omitting needless words +- using names based on roles, not types +- sometimes compensating for weak type information +- striving for fluent usage +- beginning factory methods with `make` +- naming methods for their side effects +- verb methods follow the -ed, -ing rule for the non-mutating version +- noun methods follow the formX rule for the mutating version +- boolean types should read like assertions +- protocols that describe _what something is_ should read as nouns +- protocols that describe _a capability_ should end in _-able_ or _-ible_ +- using terms that don't surprise experts or confuse beginners +- generally avoiding abbreviations +- using precedent for names +- preferring methods and properties to free functions +- casing acronyms and initialisms uniformly up or down +- giving the same base name to methods that share the same meaning +- avoiding overloads on return type +- choosing good parameter names that serve as documentation +- preferring to name the first parameter instead of including its name in the method name, except as mentioned under Delegates +- labeling closure and tuple parameters +- taking advantage of default parameters + +### Prose + +When referring to methods in prose, being unambiguous is critical. To refer to a method name, use the simplest form possible. + +1. Write the method name with no parameters. **Example:** Next, you need to call `addTarget`. +2. Write the method name with argument labels. **Example:** Next, you need to call `addTarget(_:action:)`. +3. Write the full method name with argument labels and types. **Example:** Next, you need to call `addTarget(_: Any?, action: Selector?)`. + +For the above example using `UIGestureRecognizer`, 1 is unambiguous and preferred. + +**Pro Tip:** You can use Xcode's jump bar to lookup methods with argument labels. If you’re particularly good at mashing lots of keys simultaneously, put the cursor in the method name and press **Shift-Control-Option-Command-C** (all 4 modifier keys) and Xcode will kindly put the signature on your clipboard. + +### Class Prefixes + +Swift types are automatically namespaced by the module that contains them and you should not add a class prefix such as RW. If two names from different modules collide you can disambiguate by prefixing the type name with the module name. However, only specify the module name when there is possibility for confusion which should be rare. + +```swift +import SomeModule + +let myClass = MyModule.UsefulClass() +``` + +### Delegates + +When creating custom delegate methods, an unnamed first parameter should be the delegate source. (UIKit contains numerous examples of this.) + +**Preferred**: +```swift +func namePickerView(_ namePickerView: NamePickerView, didSelectName name: String) +func namePickerViewShouldReload(_ namePickerView: NamePickerView) -> Bool +``` + +**Not Preferred**: +```swift +func didSelectName(namePicker: NamePickerViewController, name: String) +func namePickerShouldReload() -> Bool +``` + +### Use Type Inferred Context + +Use compiler inferred context to write shorter, clear code. (Also see [Type Inference](#type-inference).) + +**Preferred**: +```swift +let selector = #selector(viewDidLoad) +view.backgroundColor = .red +let toView = context.view(forKey: .to) +let view = UIView(frame: .zero) +``` + +**Not Preferred**: +```swift +let selector = #selector(ViewController.viewDidLoad) +view.backgroundColor = UIColor.red +let toView = context.view(forKey: UITransitionContextViewKey.to) +let view = UIView(frame: CGRect.zero) +``` + +### Generics + +Generic type parameters should be descriptive, upper camel case names. When a type name doesn't have a meaningful relationship or role, use a traditional single uppercase letter such as `T`, `U`, or `V`. + +**Preferred**: +```swift +struct Stack { ... } +func write(to target: inout Target) +func swap(_ a: inout T, _ b: inout T) +``` + +**Not Preferred**: +```swift +struct Stack { ... } +func write(to target: inout target) +func swap(_ a: inout Thing, _ b: inout Thing) +``` + +### Language + +Use US English spelling to match Apple's API. + +**Preferred**: +```swift +let color = "red" +``` + +**Not Preferred**: +```swift +let colour = "red" +``` + +## Code Organization + +Use extensions to organize your code into logical blocks of functionality. Each extension should be set off with a `// MARK: -` comment to keep things well-organized. + +### Protocol Conformance + +In particular, when adding protocol conformance to a model, prefer adding a separate extension for the protocol methods. This keeps the related methods grouped together with the protocol and can simplify instructions to add a protocol to a class with its associated methods. + +**Preferred**: +```swift +class MyViewController: UIViewController { +// class stuff here +} + +// MARK: - UITableViewDataSource +extension MyViewController: UITableViewDataSource { +// table view data source methods +} + +// MARK: - UIScrollViewDelegate +extension MyViewController: UIScrollViewDelegate { +// scroll view delegate methods +} +``` + +**Not Preferred**: +```swift +class MyViewController: UIViewController, UITableViewDataSource, UIScrollViewDelegate { +// all methods +} +``` + +Since the compiler does not allow you to re-declare protocol conformance in a derived class, it is not always required to replicate the extension groups of the base class. This is especially true if the derived class is a terminal class and a small number of methods are being overridden. When to preserve the extension groups is left to the discretion of the author. + +For UIKit view controllers, consider grouping lifecycle, custom accessors, and IBAction in separate class extensions. + +### Unused Code + +Unused (dead) code, including Xcode template code and placeholder comments should be removed. An exception is when your tutorial or book instructs the user to use the commented code. + +Aspirational methods not directly associated with the tutorial whose implementation simply calls the superclass should also be removed. This includes any empty/unused UIApplicationDelegate methods. + +**Preferred**: +```swift +override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int { +return Database.contacts.count +} +``` + +**Not Preferred**: +```swift +override func didReceiveMemoryWarning() { +super.didReceiveMemoryWarning() +// Dispose of any resources that can be recreated. +} + +override func numberOfSections(in tableView: UITableView) -> Int { +// #warning Incomplete implementation, return the number of sections +return 1 +} + +override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int { +// #warning Incomplete implementation, return the number of rows +return Database.contacts.count +} + +``` +### Minimal Imports + +Import only the modules a source file requires. For example, don't import `UIKit` when importing `Foundation` will suffice. Likewise, don't import `Foundation` if you must import `UIKit`. + +**Preferred**: +``` +import UIKit +var view: UIView +var deviceModels: [String] +``` + +**Preferred**: +``` +import Foundation +var deviceModels: [String] +``` + +**Not Preferred**: +``` +import UIKit +import Foundation +var view: UIView +var deviceModels: [String] +``` + +**Not Preferred**: +``` +import UIKit +var deviceModels: [String] +``` + +## Spacing + +* Indent using the standard 4 spaces. +* Method braces and other braces (`if`/`else`/`switch`/`while` etc.) always open on the same line as the statement but close on a new line. +* Tip: You can re-indent by selecting some code (or **Command-A** to select all) and then **Control-I** (or **Editor ▸ Structure ▸ Re-Indent** in the menu). Some of the Xcode template code will have 4-space tabs hard coded, so this is a good way to fix that. + +**Preferred**: +```swift +if user.isHappy { +// Do something +} else { +// Do something else +} +``` + +**Not Preferred**: +```swift +if user.isHappy +{ +// Do something +} +else { +// Do something else +} +``` + +* There should be exactly one blank line between methods to aid in visual clarity and organization. Whitespace within methods should separate functionality, but having too many sections in a method often means you should refactor into several methods. + +* There should be no blank lines after an opening brace or before a closing brace. + +* Colons always have no space on the left and one space on the right. Exceptions are the ternary operator `? :`, empty dictionary `[:]` and `#selector` syntax `addTarget(_:action:)`. + +**Preferred**: +```swift +class TestDatabase: Database { +var data: [String: CGFloat] = ["A": 1.2, "B": 3.2] +} +``` + +**Not Preferred**: +```swift +class TestDatabase : Database { +var data :[String:CGFloat] = ["A" : 1.2, "B":3.2] +} +``` + +* Long lines should be wrapped at around 70 characters. A hard limit is intentionally not specified. + +* Avoid trailing whitespaces at the ends of lines. + +* Add a single newline character at the end of each file. + +## Comments + +When they are needed, use comments to explain **why** a particular piece of code does something. Comments must be kept up-to-date or deleted. + +Avoid block comments inline with code, as the code should be as self-documenting as possible. _Exception: This does not apply to those comments used to generate documentation._ + +Avoid the use of C-style comments (`/* ... */`). Prefer the use of double- or triple-slash. + +## Classes and Structures + +### Which one to use? + +Remember, structs have [value semantics](https://developer.apple.com/library/mac/documentation/Swift/Conceptual/Swift_Programming_Language/ClassesAndStructures.html#//apple_ref/doc/uid/TP40014097-CH13-XID_144). Use structs for things that do not have an identity. An array that contains [a, b, c] is really the same as another array that contains [a, b, c] and they are completely interchangeable. It doesn't matter whether you use the first array or the second, because they represent the exact same thing. That's why arrays are structs. + +Classes have [reference semantics](https://developer.apple.com/library/mac/documentation/Swift/Conceptual/Swift_Programming_Language/ClassesAndStructures.html#//apple_ref/doc/uid/TP40014097-CH13-XID_145). Use classes for things that do have an identity or a specific life cycle. You would model a person as a class because two person objects are two different things. Just because two people have the same name and birthdate, doesn't mean they are the same person. But the person's birthdate would be a struct because a date of 3 March 1950 is the same as any other date object for 3 March 1950. The date itself doesn't have an identity. + +Sometimes, things should be structs but need to conform to `AnyObject` or are historically modeled as classes already (`NSDate`, `NSSet`). Try to follow these guidelines as closely as possible. + +### Example definition + +Here's an example of a well-styled class definition: + +```swift +class Circle: Shape { +var x: Int, y: Int +var radius: Double +var diameter: Double { +get { +return radius * 2 +} +set { +radius = newValue / 2 +} +} + +init(x: Int, y: Int, radius: Double) { +self.x = x +self.y = y +self.radius = radius +} + +convenience init(x: Int, y: Int, diameter: Double) { +self.init(x: x, y: y, radius: diameter / 2) +} + +override func area() -> Double { +return Double.pi * radius * radius +} +} + +extension Circle: CustomStringConvertible { +var description: String { +return "center = \(centerString) area = \(area())" +} +private var centerString: String { +return "(\(x),\(y))" +} +} +``` + +The example above demonstrates the following style guidelines: + ++ Specify types for properties, variables, constants, argument declarations and other statements with a space after the colon but not before, e.g. `x: Int`, and `Circle: Shape`. ++ Define multiple variables and structures on a single line if they share a common purpose / context. ++ Indent getter and setter definitions and property observers. ++ Don't add modifiers such as `internal` when they're already the default. Similarly, don't repeat the access modifier when overriding a method. ++ Organize extra functionality (e.g. printing) in extensions. ++ Hide non-shared, implementation details such as `centerString` inside the extension using `private` access control. + +### Use of Self + +For conciseness, avoid using `self` since Swift does not require it to access an object's properties or invoke its methods. + +Use self only when required by the compiler (in `@escaping` closures, or in initializers to disambiguate properties from arguments). In other words, if it compiles without `self` then omit it. + + +### Computed Properties + +For conciseness, if a computed property is read-only, omit the get clause. The get clause is required only when a set clause is provided. + +**Preferred**: +```swift +var diameter: Double { +return radius * 2 +} +``` + +**Not Preferred**: +```swift +var diameter: Double { +get { +return radius * 2 +} +} +``` + +### Final + +Marking classes or members as `final` in tutorials can distract from the main topic and is not required. Nevertheless, use of `final` can sometimes clarify your intent and is worth the cost. In the below example, `Box` has a particular purpose and customization in a derived class is not intended. Marking it `final` makes that clear. + +```swift +// Turn any generic type into a reference type using this Box class. +final class Box { +let value: T +init(_ value: T) { +self.value = value +} +} +``` + +## Function Declarations + +Keep short function declarations on one line including the opening brace: + +```swift +func reticulateSplines(spline: [Double]) -> Bool { +// reticulate code goes here +} +``` + +For functions with long signatures, put each parameter on a new line and add an extra indent on subsequent lines: + +```swift +func reticulateSplines( +spline: [Double], +adjustmentFactor: Double, +translateConstant: Int, comment: String +) -> Bool { +// reticulate code goes here +} +``` + +Don't use `(Void)` to represent the lack of an input; simply use `()`. Use `Void` instead of `()` for closure and function outputs. + +**Preferred**: + +```swift +func updateConstraints() -> Void { +// magic happens here +} + +typealias CompletionHandler = (result) -> Void +``` + +**Not Preferred**: + +```swift +func updateConstraints() -> () { +// magic happens here +} + +typealias CompletionHandler = (result) -> () +``` + +## Function Calls + +Mirror the style of function declarations at call sites. Calls that fit on a single line should be written as such: + +```swift +let success = reticulateSplines(splines) +``` + +If the call site must be wrapped, put each parameter on a new line, indented one additional level: + +```swift +let success = reticulateSplines( +spline: splines, +adjustmentFactor: 1.3, +translateConstant: 2, +comment: "normalize the display") +``` + +## Closure Expressions + +Use trailing closure syntax only if there's a single closure expression parameter at the end of the argument list. Give the closure parameters descriptive names. + +**Preferred**: +```swift +UIView.animate(withDuration: 1.0) { +self.myView.alpha = 0 +} + +UIView.animate(withDuration: 1.0, animations: { +self.myView.alpha = 0 +}, completion: { finished in +self.myView.removeFromSuperview() +}) +``` + +**Not Preferred**: +```swift +UIView.animate(withDuration: 1.0, animations: { +self.myView.alpha = 0 +}) + +UIView.animate(withDuration: 1.0, animations: { +self.myView.alpha = 0 +}) { f in +self.myView.removeFromSuperview() +} +``` + +For single-expression closures where the context is clear, use implicit returns: + +```swift +attendeeList.sort { a, b in +a > b +} +``` + +Chained methods using trailing closures should be clear and easy to read in context. Decisions on spacing, line breaks, and when to use named versus anonymous arguments is left to the discretion of the author. Examples: + +```swift +let value = numbers.map { $0 * 2 }.filter { $0 % 3 == 0 }.index(of: 90) + +let value = numbers +.map {$0 * 2} +.filter {$0 > 50} +.map {$0 + 10} +``` + +## Types + +Always use Swift's native types and expressions when available. Swift offers bridging to Objective-C so you can still use the full set of methods as needed. + +**Preferred**: +```swift +let width = 120.0 // Double +let widthString = "\(width)" // String +``` + +**Less Preferred**: +```swift +let width = 120.0 // Double +let widthString = (width as NSNumber).stringValue // String +``` + +**Not Preferred**: +```swift +let width: NSNumber = 120.0 // NSNumber +let widthString: NSString = width.stringValue // NSString +``` + +In drawing code, use `CGFloat` if it makes the code more succinct by avoiding too many conversions. + +### Constants + +Constants are defined using the `let` keyword and variables with the `var` keyword. Always use `let` instead of `var` if the value of the variable will not change. + +**Tip:** A good technique is to define everything using `let` and only change it to `var` if the compiler complains! + +You can define constants on a type rather than on an instance of that type using type properties. To declare a type property as a constant simply use `static let`. Type properties declared in this way are generally preferred over global constants because they are easier to distinguish from instance properties. Example: + +**Preferred**: +```swift +enum Math { +static let e = 2.718281828459045235360287 +static let root2 = 1.41421356237309504880168872 +} + +let hypotenuse = side * Math.root2 + +``` +**Note:** The advantage of using a case-less enumeration is that it can't accidentally be instantiated and works as a pure namespace. + +**Not Preferred**: +```swift +let e = 2.718281828459045235360287 // pollutes global namespace +let root2 = 1.41421356237309504880168872 + +let hypotenuse = side * root2 // what is root2? +``` + +### Static Methods and Variable Type Properties + +Static methods and type properties work similarly to global functions and global variables and should be used sparingly. They are useful when functionality is scoped to a particular type or when Objective-C interoperability is required. + +### Optionals + +Declare variables and function return types as optional with `?` where a `nil` value is acceptable. + +Use implicitly unwrapped types declared with `!` only for instance variables that you know will be initialized later before use, such as subviews that will be set up in `viewDidLoad()`. Prefer optional binding to implicitly unwrapped optionals in most other cases. + +When accessing an optional value, use optional chaining if the value is only accessed once or if there are many optionals in the chain: + +```swift +textContainer?.textLabel?.setNeedsDisplay() +``` + +Use optional binding when it's more convenient to unwrap once and perform multiple operations: + +```swift +if let textContainer = textContainer { +// do many things with textContainer +} +``` + +When naming optional variables and properties, avoid naming them like `optionalString` or `maybeView` since their optional-ness is already in the type declaration. + +For optional binding, shadow the original name whenever possible rather than using names like `unwrappedView` or `actualLabel`. + +**Preferred**: +```swift +var subview: UIView? +var volume: Double? + +// later on... +if let subview = subview, let volume = volume { +// do something with unwrapped subview and volume +} + +// another example +UIView.animate(withDuration: 2.0) { [weak self] in +guard let self = self else { return } +self.alpha = 1.0 +} +``` + +**Not Preferred**: +```swift +var optionalSubview: UIView? +var volume: Double? + +if let unwrappedSubview = optionalSubview { +if let realVolume = volume { +// do something with unwrappedSubview and realVolume +} +} + +// another example +UIView.animate(withDuration: 2.0) { [weak self] in +guard let strongSelf = self else { return } +strongSelf.alpha = 1.0 +} +``` + +### Lazy Initialization + +Consider using lazy initialization for finer grained control over object lifetime. This is especially true for `UIViewController` that loads views lazily. You can either use a closure that is immediately called `{ }()` or call a private factory method. Example: + +```swift +lazy var locationManager = makeLocationManager() + +private func makeLocationManager() -> CLLocationManager { +let manager = CLLocationManager() +manager.desiredAccuracy = kCLLocationAccuracyBest +manager.delegate = self +manager.requestAlwaysAuthorization() +return manager +} +``` + +**Notes:** +- `[unowned self]` is not required here. A retain cycle is not created. +- Location manager has a side-effect for popping up UI to ask the user for permission so fine grain control makes sense here. + + +### Type Inference + +Prefer compact code and let the compiler infer the type for constants or variables of single instances. Type inference is also appropriate for small, non-empty arrays and dictionaries. When required, specify the specific type such as `CGFloat` or `Int16`. + +**Preferred**: +```swift +let message = "Click the button" +let currentBounds = computeViewBounds() +var names = ["Mic", "Sam", "Christine"] +let maximumWidth: CGFloat = 106.5 +``` + +**Not Preferred**: +```swift +let message: String = "Click the button" +let currentBounds: CGRect = computeViewBounds() +var names = [String]() +``` + +#### Type Annotation for Empty Arrays and Dictionaries + +For empty arrays and dictionaries, use type annotation. (For an array or dictionary assigned to a large, multi-line literal, use type annotation.) + +**Preferred**: +```swift +var names: [String] = [] +var lookup: [String: Int] = [:] +``` + +**Not Preferred**: +```swift +var names = [String]() +var lookup = [String: Int]() +``` + +**NOTE**: Following this guideline means picking descriptive names is even more important than before. + + +### Syntactic Sugar + +Prefer the shortcut versions of type declarations over the full generics syntax. + +**Preferred**: +```swift +var deviceModels: [String] +var employees: [Int: String] +var faxNumber: Int? +``` + +**Not Preferred**: +```swift +var deviceModels: Array +var employees: Dictionary +var faxNumber: Optional +``` + +## Functions vs Methods + +Free functions, which aren't attached to a class or type, should be used sparingly. When possible, prefer to use a method instead of a free function. This aids in readability and discoverability. + +Free functions are most appropriate when they aren't associated with any particular type or instance. + +**Preferred** +```swift +let sorted = items.mergeSorted() // easily discoverable +rocket.launch() // acts on the model +``` + +**Not Preferred** +```swift +let sorted = mergeSort(items) // hard to discover +launch(&rocket) +``` + +**Free Function Exceptions** +```swift +let tuples = zip(a, b) // feels natural as a free function (symmetry) +let value = max(x, y, z) // another free function that feels natural +``` + +## Memory Management + +Code (even non-production, tutorial demo code) should not create reference cycles. Analyze your object graph and prevent strong cycles with `weak` and `unowned` references. Alternatively, use value types (`struct`, `enum`) to prevent cycles altogether. + +### Extending object lifetime + +Extend object lifetime using the `[weak self]` and `guard let self = self else { return }` idiom. `[weak self]` is preferred to `[unowned self]` where it is not immediately obvious that `self` outlives the closure. Explicitly extending lifetime is preferred to optional chaining. + +**Preferred** +```swift +resource.request().onComplete { [weak self] response in +guard let self = self else { +return +} +let model = self.updateModel(response) +self.updateUI(model) +} +``` + +**Not Preferred** +```swift +// might crash if self is released before response returns +resource.request().onComplete { [unowned self] response in +let model = self.updateModel(response) +self.updateUI(model) +} +``` + +**Not Preferred** +```swift +// deallocate could happen between updating the model and updating UI +resource.request().onComplete { [weak self] response in +let model = self?.updateModel(response) +self?.updateUI(model) +} +``` + +## Access Control + +Full access control annotation in tutorials can distract from the main topic and is not required. Using `private` and `fileprivate` appropriately, however, adds clarity and promotes encapsulation. Prefer `private` to `fileprivate`; use `fileprivate` only when the compiler insists. + +Only explicitly use `open`, `public`, and `internal` when you require a full access control specification. + +Use access control as the leading property specifier. The only things that should come before access control are the `static` specifier or attributes such as `@IBAction`, `@IBOutlet` and `@discardableResult`. + +**Preferred**: +```swift +private let message = "Great Scott!" + +class TimeMachine { +private dynamic lazy var fluxCapacitor = FluxCapacitor() +} +``` + +**Not Preferred**: +```swift +fileprivate let message = "Great Scott!" + +class TimeMachine { +lazy dynamic private var fluxCapacitor = FluxCapacitor() +} +``` + +## Control Flow + +Prefer the `for-in` style of `for` loop over the `while-condition-increment` style. + +**Preferred**: +```swift +for _ in 0..<3 { +print("Hello three times") +} + +for (index, person) in attendeeList.enumerated() { +print("\(person) is at position #\(index)") +} + +for index in stride(from: 0, to: items.count, by: 2) { +print(index) +} + +for index in (0...3).reversed() { +print(index) +} +``` + +**Not Preferred**: +```swift +var i = 0 +while i < 3 { +print("Hello three times") +i += 1 +} + + +var i = 0 +while i < attendeeList.count { +let person = attendeeList[i] +print("\(person) is at position #\(i)") +i += 1 +} +``` + +### Ternary Operator + +The Ternary operator, `?:` , should only be used when it increases clarity or code neatness. A single condition is usually all that should be evaluated. Evaluating multiple conditions is usually more understandable as an `if` statement or refactored into instance variables. In general, the best use of the ternary operator is during assignment of a variable and deciding which value to use. + +**Preferred**: + +```swift +let value = 5 +result = value != 0 ? x : y + +let isHorizontal = true +result = isHorizontal ? x : y +``` + +**Not Preferred**: + +```swift +result = a > b ? x = c > d ? c : d : y +``` + +## Golden Path + +When coding with conditionals, the left-hand margin of the code should be the "golden" or "happy" path. That is, don't nest `if` statements. Multiple return statements are OK. The `guard` statement is built for this. + +**Preferred**: +```swift +func computeFFT(context: Context?, inputData: InputData?) throws -> Frequencies { + +guard let context = context else { +throw FFTError.noContext +} +guard let inputData = inputData else { +throw FFTError.noInputData +} + +// use context and input to compute the frequencies +return frequencies +} +``` + +**Not Preferred**: +```swift +func computeFFT(context: Context?, inputData: InputData?) throws -> Frequencies { + +if let context = context { +if let inputData = inputData { +// use context and input to compute the frequencies + +return frequencies +} else { +throw FFTError.noInputData +} +} else { +throw FFTError.noContext +} +} +``` + +When multiple optionals are unwrapped either with `guard` or `if let`, minimize nesting by using the compound version when possible. In the compound version, place the `guard` on its own line, then ident each condition on its own line. The `else` clause is indented to match the conditions and the code is indented one additional level, as shown below. Example: + +**Preferred**: +```swift +guard +let number1 = number1, +let number2 = number2, +let number3 = number3 +else { +fatalError("impossible") +} +// do something with numbers +``` + +**Not Preferred**: +```swift +if let number1 = number1 { +if let number2 = number2 { +if let number3 = number3 { +// do something with numbers +} else { +fatalError("impossible") +} +} else { +fatalError("impossible") +} +} else { +fatalError("impossible") +} +``` + +### Failing Guards + +Guard statements are required to exit in some way. Generally, this should be simple one line statement such as `return`, `throw`, `break`, `continue`, and `fatalError()`. Large code blocks should be avoided. If cleanup code is required for multiple exit points, consider using a `defer` block to avoid cleanup code duplication. + +## Semicolons + +Swift does not require a semicolon after each statement in your code. They are only required if you wish to combine multiple statements on a single line. + +Do not write multiple statements on a single line separated with semicolons. + +**Preferred**: +```swift +let swift = "not a scripting language" +``` + +**Not Preferred**: +```swift +let swift = "not a scripting language"; +``` + +**NOTE**: Swift is very different from JavaScript, where omitting semicolons is [generally considered unsafe](http://stackoverflow.com/questions/444080/do-you-recommend-using-semicolons-after-every-statement-in-javascript) + +## Parentheses + +Parentheses around conditionals are not required and should be omitted. + +**Preferred**: +```swift +if name == "Hello" { +print("World") +} +``` + +**Not Preferred**: +```swift +if (name == "Hello") { +print("World") +} +``` + +In larger expressions, optional parentheses can sometimes make code read more clearly. + +**Preferred**: +```swift +let playerMark = (player == current ? "X" : "O") +``` + +## Multi-line String Literals + +When building a long string literal, you're encouraged to use the multi-line string literal syntax. Open the literal on the same line as the assignment but do not include text on that line. Indent the text block one additional level. + +**Preferred**: + +```swift +let message = """ +You cannot charge the flux \ +capacitor with a 9V battery. +You must use a super-charger \ +which costs 10 credits. You currently \ +have \(credits) credits available. +""" +``` + +**Not Preferred**: + +```swift +let message = """You cannot charge the flux \ +capacitor with a 9V battery. +You must use a super-charger \ +which costs 10 credits. You currently \ +have \(credits) credits available. +""" +``` + +**Not Preferred**: + +```swift +let message = "You cannot charge the flux " + +"capacitor with a 9V battery.\n" + +"You must use a super-charger " + +"which costs 10 credits. You currently " + +"have \(credits) credits available." +``` + +## No Emoji + +Do not use emoji in your projects. For those readers who actually type in their code, it's an unnecessary source of friction. While it may be cute, it doesn't add to the learning and it interrupts the coding flow for these readers. + +## Organization and Bundle Identifier + +Where an Xcode project is involved, the organization should be set to `hcahealthcare` and the Bundle Identifier set to `com.hcahealthcare.{AppName}` + +## Copyright Statement + +The following copyright statement should be included at the top of every source +file: + +```swift +/// Copyright (c) 2019 HCA Healthcare Holdings Inc. +``` + +## References + +* [Ray Wenderlich Style Guide](https://github.com/raywenderlich/swift-style-guide) From 93b4471b9ccc7eb673bf382e62d62da7beebdeeb Mon Sep 17 00:00:00 2001 From: HGE6730 <> Date: Thu, 31 Jan 2019 13:12:13 -0600 Subject: [PATCH 2/5] TOC updates --- Mobile-Standards/README.md | 5 ++--- README.md | 1 + 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Mobile-Standards/README.md b/Mobile-Standards/README.md index af02691..087cace 100644 --- a/Mobile-Standards/README.md +++ b/Mobile-Standards/README.md @@ -1,9 +1,8 @@ # Mobile-Standards -This section describes our standards and best practices related to mobile apps. Our goal is have cohesion across all of HCA's development efforts. +This section describes our standards and best practices related to mobile apps. Our goal is have cohesion across all of HCA's development efforts. | Section | | |--|--| -|[Styling - Swift Functional](/Code-Standards/swift-functional.md)|Coding style for Swift project following functional| -|[Styling - Swift Object-Oriented](/Code-Standards/swift-oop.md)|Coding style for Swift project following OOP| +|[Mobile Standards](/Mobile-Standards/mobile-alerting-and-sounds-standard.md)|Guidelines and standards for sounds being emitted from mobile devices at HCA| diff --git a/README.md b/README.md index e8185bd..c69308a 100644 --- a/README.md +++ b/README.md @@ -9,5 +9,6 @@ This repo is a work in progress, please feel free to submit a PR. There will mor |[Code-Standards](/Code-Standards/README.md)|Standards of writing, contains items like code style.| |[Engineering-Principles](/Engineering-Principles/README.md)|Guiding principles of engineering| |[Onboarding](/Onboarding/README.md)|Resources for your first days here at HCA.| +|[Mobile-Standards](/Mobile-Standards/README.md)|Standards for mobile development at HCA.| From b1dd0f30c742d63a2978c5eaee43c2db9ece896d Mon Sep 17 00:00:00 2001 From: HGE6730 <> Date: Thu, 31 Jan 2019 13:34:14 -0600 Subject: [PATCH 3/5] Readme fix --- Mobile-Standards/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Mobile-Standards/README.md b/Mobile-Standards/README.md index 087cace..9d73e37 100644 --- a/Mobile-Standards/README.md +++ b/Mobile-Standards/README.md @@ -4,5 +4,5 @@ This section describes our standards and best practices related to mobile apps. | Section | | |--|--| -|[Mobile Standards](/Mobile-Standards/mobile-alerting-and-sounds-standard.md)|Guidelines and standards for sounds being emitted from mobile devices at HCA| +|[Mobile Alerting and Sounds Standard](/Mobile-Standards/mobile-alerting-and-sounds-standard.md)|Guidelines and standards for sounds being emitted from mobile devices at HCA| From 80256e2150412008cdfa3438d2d742b892db62d1 Mon Sep 17 00:00:00 2001 From: HGE6730 <> Date: Thu, 31 Jan 2019 13:49:12 -0600 Subject: [PATCH 4/5] TOC is now alphabetical --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c69308a..192796c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repo is a work in progress, please feel free to submit a PR. There will mor |--|--| |[Code-Standards](/Code-Standards/README.md)|Standards of writing, contains items like code style.| |[Engineering-Principles](/Engineering-Principles/README.md)|Guiding principles of engineering| -|[Onboarding](/Onboarding/README.md)|Resources for your first days here at HCA.| |[Mobile-Standards](/Mobile-Standards/README.md)|Standards for mobile development at HCA.| +|[Onboarding](/Onboarding/README.md)|Resources for your first days here at HCA.| From 919f023de2374cdb56d17ae7782248cafae1117e Mon Sep 17 00:00:00 2001 From: BandoKal Date: Fri, 1 Feb 2019 14:48:10 -0600 Subject: [PATCH 5/5] Update Sounds Standard NonClinical description post code review Co-Authored-By: skyem --- Mobile-Standards/mobile-alerting-and-sounds-standard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Mobile-Standards/mobile-alerting-and-sounds-standard.md b/Mobile-Standards/mobile-alerting-and-sounds-standard.md index 51f9633..9e55fa6 100644 --- a/Mobile-Standards/mobile-alerting-and-sounds-standard.md +++ b/Mobile-Standards/mobile-alerting-and-sounds-standard.md @@ -6,7 +6,7 @@ This document is intended to set guidelines and standards on sounds being emitte ## Non-Clinical Environment -Sounds introduced into the non-clinical environment should augment the patient/clinician experience not disrupt it. When selecting sounds, one should ensure that it is appropriate for the goal of the sound alert, ringtone, or alarm. The sounds should be in alignment with the following: +Sounds introduced into the non-clinical environment should augment the user experience not disrupt it. When selecting sounds, one should ensure that it is appropriate for the goal of the sound alert, ringtone, or alarm. The sounds should be in alignment with the following: * Sounds should not mimic common emergency sounds or sirens. * Sounds should be considered professional in nature