/** and /* in Java Comments -


what's difference between 

/**  * comment  *  *  */

and 

/*  *   * comment  *  */

in java? when should use them?

the first form called javadoc. use when you're writing formal apis code, generated javadoc tool. example, the java 7 api page uses javadoc , generated tool.

some common elements you'd see in javadoc include:

  • @param: used indicate parameters being passed method, , value they're expected have

  • @return: used indicate result method going give back

  • @throws: used indicate method throws exception or error in case of input

  • @since: used indicate earliest java version class or function available in

as example, here's javadoc compare method of integer:

/**  * compares 2 {@code int} values numerically.  * value returned identical returned by:  * <pre>  *    integer.valueof(x).compareto(integer.valueof(y))  * </pre>  *  * @param  x first {@code int} compare  * @param  y second {@code int} compare  * @return value {@code 0} if {@code x == y};  *         value less {@code 0} if {@code x < y}; ,  *         value greater {@code 0} if {@code x > y}  * @since 1.7  */ public static int compare(int x, int y) {     return (x < y) ? -1 : ((x == y) ? 0 : 1); }

the second form block (multi-line) comment. use if want have multiple lines in comment.

i you'd want use latter form sparingly; is, don't want overburden code block comments don't describe behaviors method/complex function supposed have.

since javadoc more descriptive of two, , can generate actual documentation result of using it, using javadoc more preferable simple block comments.


-

Popular posts from this blog

c# - ODP.NET Oracle.ManagedDataAccess causes ORA-12537 network session end of file -

overview i want replace oracle.dataaccess orcale. managed dataaccess, opening connection latter throws ora-12537 network session end of file exception. exception message / stack trace {oracleinternal.network.networkexception (0x000030f9): ora-12537 : netzwerksession: dateiende @ oracleinternal.network.readerstream.read(orabuf ob) @ oracleinternal.ttc.orabufreader.getdatafromnetwork() @ oracleinternal.ttc.orabufreader.read(boolean bignoredata) @ oracleinternal.ttc.marshallingengine.unmarshalub1(boolean bignoredata) @ oracleinternal.ttc.ttcprotocolnegotiation.readresponse()} i trying connect oracle 11g database , not have client installed on local machine. working test application (unmanaged) using oracle.dataaccess works fine . using system; using oracle.dataaccess.client; namespace app.odp.unmanaged { internal class program { private static void main(string[] args) { //dummy connection string...
Read more

matlab - Compression and Decompression of ECG Signal using HUFFMAN ALGORITHM -

i want compress , decompress ecg signal stored text message text file , find out file size, cr,prd ratio,and qs. here code compression , decompression of ecg signal using huffman algorithm. i'm trying find out file size, compression ratio,prd ratio,qs. but error i'm getting the ecg file in text format. %clearing variables , screen enter code here clear all; close all; clc; [file1]=uigetfile('*.txt'); %fprintf('enter ecg file name :%s',file1); p=file1; t=sprintf('%s',p); b1=dlmread([file1]); len=length(b1); lead=input('enter lead number :'); %lead=str2double(lead); col2=b1(1:end,lead); e=fix(sqrt(len)); m=1; i=1:e j=1:e g2(i,j)=fix(col2(m)*1000); %amplifying 1000 m=m+1; end end g3=g2; i=1:e j=1:e ...
Read more

utf 8 - split utf-8 string into bytes in python -

i trying split utf-8 string bytes in python 3. problem is, when use bytearray, byte, encode etc functions array size of element 14 bytes, not 1 byte expected. need split text file sequence of bytes , send them byte after byte using sockets. tried this: infile = open (file, "r") str = infile.read() byte_str = bytes(str, 'utf-8') print("size of byte_str",sys.getsizeof(byte_str[0])) print gives me 14, need 1... suggestion? quoting official documentation : sys.getsizeof(object[, default]) return size of object in bytes. object can type of object. built-in objects return correct results, not have hold true third-party extensions implementation specific. only memory consumption directly attributed object accounted for, not memory consumption of objects refers to. if given, default returned if object not provide means retrieve size. otherwise typeerror raised. getsizeof() calls object’s __sizeof__ method , adds ...
Read more