'. '

Evolution of an API is Different to the Evolution of an SPI

From APIDesign

(Difference between revisions)
Jump to: navigation, search
Current revision (13:49, 8 April 2008) (edit) (undo)
(Removing all content from page)
 
Line 1: Line 1:
-
Page 124, <tt>CountingWriter</tt> code example: <tt>@author</tt> tag probably not needed.
 
-
Page 126, code example: <tt>convertChar</tt> is a very bad name for the function -- it doesn't hint what the method does. Suggest calling <tt>rot13</tt> instead of <tt>convertChar</tt>. You don't even need to list the code for <tt>rot13</tt>, a comment above the line where you call it should be enough for those readers who haven't encountered this algorithm yet.
 
-
 
-
Page 126, para -2: typo in <tt>BufferedReader.writer(String)</tt>.
 
-
 
-
Page 129: weird formatting of <tt>write(char cbuf[])</tt> and <tt>write(String str)</tt>. This code example also uses <tt>arr</tt> and <tt>cbuff</tt> interchangeably, please consider consistently using a single name.
 
-
 
-
The example is perhaps a bit too long. Considering that you made it up, are all those overloaded <tt>write</tt> methods necessary?
 
-
 
-
Page 131: the parameter of <tt>create(ImplSeq impl)</tt> should be named <tt>seq</tt> for the sake of consistency.
 
-
 
-
--[[User:AndreiBadea|AndreiBadea]] 13:46, 8 April 2008 (UTC)
 

Current revision

Personal tools
buy