Android samples comments BEGIN_INCLUDE END_INCLUDE -

-

while reading android samples see comments 

// begin_include (something) // end_include (something)

however, current ide — android studio 1.1 — can not recognise them (or maybe wrong). guess, serve kind of code region marks (like

//<editor-fold desc="region name">  // code //</editor-fold>

in androidstudio/intellijidea), such syntax c++ preprocessor directives. question: should know important these comments (besides obvious commenting function) improve code in way?

it's documentation purposes, used identifying snippets include in target documentation. it's not useful when editing code; it's useful avoiding repetition generating documentation actual code.

{@sample} , {@include}

these tags copy sample text arbitrary file output javadoc html.

the @include tag copies text verbatim given file.

the @sample tag

  • copies text given file , strips leading , trailing whitespace
  • reduces indent level of text indent level of first non-whitespace line
  • escapes <, >; , & characters html
  • drops lines containing either begin_include or end_include sample code can nested

both tags accept either filename , id or filename. if no id provided, entire file copied. if id provided, lines in given file between first 2 lines containing begin_include(id) , end_include(id), given id, copied. id may letters, numbers , underscore ().

four examples:

{@include samples/samplecode/src/com/google/app/notification1.java} {@sample samples/samplecode/src/com/google/app/notification1.java} {@include samples/samplecode/src/com/google/app/notification1.java bleh} {@sample samples/samplecode/src/com/google/app/notification1.java bleh}

https://code.google.com/p/doclava/wiki/javadoctags


Comments

Post a Comment

Popular posts from this blog

node.js - Mongoose: Cast to ObjectId failed for value on newly created object after setting the value -

-
this question has answer here: what's mongoose error cast objectid failed value xxx @ path “_id”? 7 answers even though has been asked many times because entity has no valid objectid field. i came across situation objectid set value can casted objectid still error. the schema: var serviceschema = parammongoose.schema({ servicename:{ type: parammongoose.schema.types.objectid , ref: 'servicenames',required:true } }); pseudo code: servicefromdb=new service({servicename:'some name'}); servicefromdb.servicename='000000000000000000000001'; servicefromdb.save(function(paramerror,paramdata){ if(paramerror){ console.log('but but...',servicefromdb,paramerror) } }); the output of code is: but but... { servicename: 000000000000000000000001, _id: 55079a90286f49280364f78b } { [casterror: cast objectid faile...
Read more

gradle error "Cannot convert the provided notation to a File or URI" -

-
i have defined 2 system properties in gradle.properties: systemprop.builddir=build systemprop.cfgdir=build\\cfg and have following task defined in build.gradle: task clean(group:'clean',description:'clean project') << { ant.sequential { delete(dir: system.properties.builddir) mkdir(dir: system.properties.builddir) delete(dir: system.properties.cfgdir) mkdir(dir: system.properties.cfgdir) } } this generates following error: execution failed task ':clean'. > cannot convert provided notation file or uri: {dir=build}. following types/formats supported: - string or charsequence path, e.g 'src/main/java' or '/usr/include' - string or charsequence uri, e.g 'file:/usr/include' - file instance. - uri or url instance. but equivalent block of code not generate error , works expected: task clean(group:'clean',description:'clean project') << { ...
Read more

python - NameError: name 'subprocess' is not defined -

-
i'm trying make rng website: http://jamesdotcom.com/?p=417 . when run following code: captureimage = subprocess.popen( [ "fswebcam", "-r", "356x292", "-d", "/dev/video0", "static.jpg", "--skip", "10" ], stdout=devnull, stderr=devnull) captureimage.communicate() i following error message: nameerror: name 'subprocess' not defined what should do? thanks have imported first? import subprocess captureimage = subprocess.popen(["fswebcam", ...) subprocess included in python standard library since python 2.4. should not necessary install it.
Read more