Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-1176

Public types, methods and fields (API) should be documented

    XMLWordPrintable

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      Hide
      Document this public [class|interface|method|constructor|field|enum|annotation].
      Document the parameter(s): {...}
      Document this method return value.
      Show
      Document this public [class|interface|method|constructor|field|enum|annotation]. Document the parameter(s): {...} Document this method return value.
    • List of parameters:
      Hide

      Key: forClasses
      Description: Pattern of classes which should adhere to this constraint. Ex : */api/*
      Default: */api/*

      Show
      Key: forClasses Description: Pattern of classes which should adhere to this constraint. Ex : * /api/ * Default: * /api/ *
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Covered Languages:
      Flex, Java
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      10min
    • Analysis Scope:
      Main Sources, Test Sources
    • Checkstyle:
      JavadocType, JavadocMethod
    • ESLint:
      require-jsdoc

      Description

      Try to imagine using a standard library without documentation.
      It would be a nightmare, because documentation is the only way to understand of the contract of the API. Documenting an API increases the productivity of the developers consuming it.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              freddy.mallet Freddy Mallet (Inactive)
              Votes:
              2 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated: