desc | A programmatic approach to marking and tagging code that is strongly typed and consistent |
date | 2021-01-03 |
version | 2.0.0 |
jar | slatekit.common.jar |
namespace | slatekit.common |
artifact | com.slatekit:slatekit-common |
source folder | src/lib/kotlin/slatekit-common/src/main/kotlin/slatekit/common |
example | src/lib/kotlin/slate-examples/src/main/kotlin/slatekit/examples/Example_NOTE.kt |
depends on | slatekit-results |
// other setup ...
repositories {
maven { url "https://dl.bintray.com/codehelixinc/slatekit" }
}
dependencies {
// other libraries
// slatekit-common: Utilities for Android or Server
compile 'com.slatekit:slatekit-common:0.9.35'
}
// required
import slatekit.common.NOTE
// optional
import slatekit.cmds.Command
import slatekit.cmds.CommandRequest
import slatekit.results.Success
import slatekit.results.Try
n/a
// About: Strongly typed, structured representation of code notes/tasks
// This is in code to enforce consistent usage and to be able
// to track code usages
// Use case 1: Implement
NOTE.IMPLEMENT("Component 1", "This code needs further error handling" )
// Use case 2: Supply a block of code to refactor
NOTE.REFACTOR("Feature 2", "Refactor logic to handle empty values") {
// Your code to refactor goes here
}
// Use case 3: Mark a bug
NOTE.BUG("Component 3", "invalid data, bug fix needed", "JIRA:12434" )
// Use case 4: Code removal tag
NOTE.REMOVE("Story 123", "@kishore, this code no longer needed") {
// Your code to remove here.
}