JohnCoates/Aerial

View on GitHub
Aerial/Source/Models/ManifestLoader.swift

Summary

Maintainability
F
3 days
Test Coverage

File ManifestLoader.swift has 495 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import Foundation
import ScreenSaver
import GameplayKit
import AVFoundation

Severity: Minor
Found in Aerial/Source/Models/ManifestLoader.swift - About 7 hrs to fix

    Function getOldFilesEstimation has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        func getOldFilesEstimation() -> (String, Int) {
            // loadedManifests contains the full deduplicated list of videos
            debugLog("Looking for outdated files")
    
            if loadedManifest.isEmpty {
    Severity: Minor
    Found in Aerial/Source/Models/ManifestLoader.swift - About 2 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function findDuplicate has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

        func findDuplicate(id: String, url1080pH264: String) -> (Bool, AerialVideo?) {
            // We blacklist some duplicates
            if url1080pH264 != "" {
                if blacklist.contains((URL(string: url1080pH264)?.lastPathComponent)!) {
                    return (true, nil)
    Severity: Minor
    Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function generatePlaylist has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

        func generatePlaylist(isRestricted: Bool, restrictedTo: String) {
            // Start fresh
            playlist = [AerialVideo]()
            playlistIsRestricted = isRestricted
            playlistRestrictedTo = restrictedTo
    Severity: Minor
    Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function loadCachedManifests has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        func loadCachedManifests() {
            if let cacheDirectory = VideoCache.appSupportDirectory {
                // tvOS13
                var cacheFileUrl = URL(fileURLWithPath: cacheDirectory as String)
                cacheFileUrl.appendPathComponent("tvos13.json")
    Severity: Minor
    Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function getOldFilesEstimation has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        func getOldFilesEstimation() -> (String, Int) {
            // loadedManifests contains the full deduplicated list of videos
            debugLog("Looking for outdated files")
    
            if loadedManifest.isEmpty {
    Severity: Minor
    Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

      Function loadCachedManifests has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          func loadCachedManifests() {
              if let cacheDirectory = VideoCache.appSupportDirectory {
                  // tvOS13
                  var cacheFileUrl = URL(fileURLWithPath: cacheDirectory as String)
                  cacheFileUrl.appendPathComponent("tvos13.json")
      Severity: Minor
      Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

        Function loadManifestsFromLoadedFiles has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            func loadManifestsFromLoadedFiles() {
                // Reset our array
                processedVideos = []
        
                if manifestTvOS13 != nil {
        Severity: Minor
        Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

          Function loadManifestsFromLoadedFiles has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

              func loadManifestsFromLoadedFiles() {
                  // Reset our array
                  processedVideos = []
          
                  if manifestTvOS13 != nil {
          Severity: Minor
          Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Function moveOldManifests has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

              func moveOldManifests() {
                  debugLog("move")
                  let cacheDirectory = VideoCache.appSupportDirectory!
                  var cacheResourcesString = cacheDirectory
          
          
          Severity: Minor
          Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Function checkIfShouldRedownloadFiles has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              func checkIfShouldRedownloadFiles() {
                  let dateFormatter = DateFormatter()
                  dateFormatter.dateFormat = "yyyy-MM-dd"
                  dateFormatter.locale = Locale.init(identifier: "en_GB")
                  let dateObj = dateFormatter.date(from: PrefsVideos.lastVideoCheck)
          Severity: Minor
          Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

            Function reloadFiles has 29 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                func reloadFiles() {
                    moveOldManifests()
            
                    // Ok then, we fetch them...
                    debugLog("Fetching missing manifests online")
            Severity: Minor
            Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

              Function moveOldManifests has 28 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  func moveOldManifests() {
                      debugLog("move")
                      let cacheDirectory = VideoCache.appSupportDirectory!
                      var cacheResourcesString = cacheDirectory
              
              
              Severity: Minor
              Found in Aerial/Source/Models/ManifestLoader.swift - About 1 hr to fix

                Function checkIfShouldRedownloadFiles has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    func checkIfShouldRedownloadFiles() {
                        let dateFormatter = DateFormatter()
                        dateFormatter.dateFormat = "yyyy-MM-dd"
                        dateFormatter.locale = Locale.init(identifier: "en_GB")
                        let dateObj = dateFormatter.date(from: PrefsVideos.lastVideoCheck)
                Severity: Minor
                Found in Aerial/Source/Models/ManifestLoader.swift - About 35 mins to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Avoid too many return statements within this function.
                Open

                        return (false, nil)
                Severity: Major
                Found in Aerial/Source/Models/ManifestLoader.swift - About 30 mins to fix

                  Function randomVideo has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      func randomVideo(excluding: [AerialVideo]) -> (AerialVideo?, Bool) {
                          var shouldLoop = false
                          let timeManagement = TimeManagement.sharedInstance
                          let (shouldRestrictByDayNight, restrictTo) = timeManagement.shouldRestrictPlaybackToDayNightVideo()
                  
                  
                  Severity: Minor
                  Found in Aerial/Source/Models/ManifestLoader.swift - About 25 mins to fix

                  Cognitive Complexity

                  Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                  A method's cognitive complexity is based on a few simple rules:

                  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                  • Code is considered more complex for each "break in the linear flow of the code"
                  • Code is considered more complex when "flow breaking structures are nested"

                  Further reading

                  Identical blocks of code found in 2 locations. Consider refactoring.
                  Open

                          for video in processedVideos {
                              if id == video.id {
                                  return (true, video)
                              } else if url1080pH264 != "" && video.urls[.v1080pH264] != "" {
                                  if URL(string: url1080pH264)?.lastPathComponent == URL(string: video.urls[.v1080pH264]!)?.lastPathComponent {
                  Severity: Major
                  Found in Aerial/Source/Models/ManifestLoader.swift and 1 other location - About 1 hr to fix
                  Aerial/Source/Models/Sources/SourceInfo.swift on lines 317..325

                  Duplicated Code

                  Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                  Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                  When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                  Tuning

                  This issue has a mass of 112.

                  We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                  The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                  If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                  See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                  Refactorings

                  Further Reading

                  Identical blocks of code found in 2 locations. Consider refactoring.
                  Open

                      func getResolution(asset: AVAsset) -> CGSize {
                          guard let track = asset.tracks(withMediaType: AVMediaType.video).first else { return CGSize.zero }
                          let size = track.naturalSize.applying(track.preferredTransform)
                          return CGSize(width: abs(size.width), height: abs(size.height))
                      }
                  Severity: Major
                  Found in Aerial/Source/Models/ManifestLoader.swift and 1 other location - About 1 hr to fix
                  Aerial/Source/Controllers/CustomVideoController.swift on lines 481..485

                  Duplicated Code

                  Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                  Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                  When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                  Tuning

                  This issue has a mass of 94.

                  We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                  The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                  If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                  See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                  Refactorings

                  Further Reading

                  Identical blocks of code found in 2 locations. Consider refactoring.
                  Open

                          if url1080pH264 != "" {
                              if blacklist.contains((URL(string: url1080pH264)?.lastPathComponent)!) {
                                  return (true, nil)
                              }
                          }
                  Severity: Minor
                  Found in Aerial/Source/Models/ManifestLoader.swift and 1 other location - About 40 mins to fix
                  Aerial/Source/Models/Sources/SourceInfo.swift on lines 303..307

                  Duplicated Code

                  Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                  Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                  When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                  Tuning

                  This issue has a mass of 52.

                  We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                  The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                  If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                  See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                  Refactorings

                  Further Reading

                  Multiline comment should start with whitespace
                  Open

                          /*if preferences.synchronizedMode {

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                          }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                      }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                          }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should start with whitespace
                  Open

                              /*for video in shuffled {

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Single-line comment should start with whitespace
                  Open

                          //debugLog("Interval : \(String(describing: dateObj?.timeIntervalSinceNow))")

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should start with whitespace
                  Open

                              /*let inRotation = preferences.videoIsInRotation(videoID: video.id)

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                          }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Colon at column 32 should have exactly one space after it
                  Open

                      func addCallback(_ callback:@escaping ManifestLoadCallback) {

                  colon-whitespace

                  There should be no whitespace preceding the colon, exactly one whitespace after the colon for: * var, class, struct, protocol, extension, func, and tuple declarations * dict literals and types * case statements

                  However, for conditional expressions there should be a single whitespace before and after the colon.

                  Variable declarations

                  Preferred

                  var x: Int = 2

                  Not Preferred

                  var x : Int
                  var y:   String

                  Dictionary literals and types

                  Preferred

                  var x = [ 'key1': 1, 'key2': 2 ]
                  var y: [ Int: String ]

                  Not Preferred

                  var x = [ 'key1' : 1, 'key2':  3]
                  var y: [ Int :    String ]

                  Case statements

                  Preferred

                  switch character {
                  case "a": doSomething(a);
                  default: alert();
                  }

                  Not Preferred

                  switch character {
                  case "a" : doSomething(a);
                  default:     alert();
                  }

                  Class, Struct, Protocol, and Extension declarations

                  Preferred

                  class ClassName: BaseClass {
                  }
                  
                  struct StructName: BaseStruct {
                  }
                  
                  protocol ProtocolName: AnotherProtocol {
                  }
                  
                  extension TypeName: ProtocolName {
                  }

                  Not Preferred

                  class ClassName : BaseClass {
                  }
                  
                  struct StructName:  BaseStruct {
                  }
                  
                  protocol ProtocolName:AnotherProtocol {
                  }
                  
                  extension TypeName : ProtocolName {
                  }

                  Tuple declarations

                  Preferred

                  var y = (key: 1, value: 2)

                  Not Preferred

                  var y = (key:1, value : 2)

                  Function declarations

                  Preferred

                  func someFunction<t: someclass u: someprotocol>(someT: T, someU: U) {
                  }</t:>

                  Not Preferred

                  func someFunction<t : someclass u:someprotocol>(someT: T, someU: U) {
                  }</t>

                  Conditional expressions

                  Preferred

                  var x = condition ? a : b

                  Not Preferred

                  var x = condition ? a: b
                  var x = condition ? a   : b

                  Multiline comment should end with whitespace
                  Open

                              }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                          }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  Multiline comment should end with whitespace
                  Open

                              }*/

                  comment-whitespace

                  Prefer at least one whitespace character after a comment opening symbol (//, ///, /*, or /**) and at least one whitespace character before a comment closing symbol (*/).

                  Preferred

                  // This is a comment
                  
                  /// This is a documentation comment
                  
                  /* This is a
                  multi-line comment */
                  
                  /* This is a
                  multi-line comment
                  */
                  
                  /** This is a
                  documentation multi-line
                  comment
                  */

                  Not Preferred

                  //This is a comment
                  
                  ///This is a documentation comment
                  
                  /*This is a
                  multi-line comment*/
                  
                  /**This is a multi-line
                  documentation comment */

                  There are no issues that match your filters.

                  Category
                  Status