<div dir="ltr">It is not the fault of the language the lacking of documentation, it is a lacking of the developers that use it. Java has (and has had since the beginning) an inbuilt system called java-doc which generates markup in comments into documentation.<div><br></div><div><a href="https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/org/apache/commons/lang/StringUtils.html">https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/org/apache/commons/lang/StringUtils.html</a><br></div><div><br></div><div>I have some interesting prospective on documentation:<br><br>1) Documentation in code is almost impossible to keep accurate. In many cases most things you two to document internally like "clear box" documentation, hurts readability and is so difficult to keep in sync with actual code.</div><div><br></div><div>2) Who is the documentation for. Inside a method to authenticate with oauth, what do you document the entire oauth protocol? What the application is supposed to do? </div><div><br></div><div>3) People don't read anyway. I have written 2 books on Cassandra and Hive. At my work we use both. In addition to the books I have ALSO field out our internal wiki with site specific information.<br><br>How many RTFM questions do you think I continuously field? Shockingly no 1/15 people in our group and in ops have actually purchased one of my books, 2 other people I have actually handed the books and they never read them.</div><div><br></div><div>A few weeks back someone actually said to me, "I was trying to figure out XYZ and I looked in your book and it was right there!"<br><br>What a REVELATION! <br><br>Do you really read docs? If people did, STACKOVERFLOW would not be a run away success! No one reads anything they just want the star trek computer / google to answer any question they dont know instantly, and they dont want to have to care about how anything works.</div><div><br></div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Sun, Apr 17, 2016 at 11:58 AM, Sujit K M <span dir="ltr"><<a href="mailto:kmsujit@gmail.com" target="_blank">kmsujit@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><div><br></div><div>I agree with whole of the comments except for the one below. </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div bgcolor="#FFFFFF" text="#000000">
when you tackle a task, like java, there's just a ton of libraries
that you can leverage off of...</div></blockquote><div> </div><div>You would find tonnes of packages in Python too. But Java for instance, In my job, Where I deal</div><div>with services, I find people to be suffering from an IN/OUT Syndrome where in all the work they</div><div>carry out is to map an input/configurations/database/configurations/partial output and repeat.</div><div>This according to me is bad.</div><div><br></div><div>The other thing I find difficult with Java is that these tonnes of libraries, have documentation which</div><div>is not worth a penny or useful. I mean does Apache for instance provide performance issues as a</div><div>part of documentation. I find testers who also should have a part in documentation, not doing this.</div><div>Un-Chartered waters I guess.</div><div><br></div><div><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div bgcolor="#FFFFFF" text="#000000"><div><div><br>
<br>
<br>
<div>On 4/17/2016 10:07 AM, A. Jesse Jiryu
Davis wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">I agree — Python is designed with the philosophy
that "readability counts" and it is successful at that. Python
code is some of the most readable of any programming language.
The language also has disadvantages, of course, but its clarity
is unsurpassed.</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">On Sun, Apr 17, 2016 at 9:30 AM, Sujit
K M <span dir="ltr"><<a href="mailto:kmsujit@gmail.com" target="_blank">kmsujit@gmail.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr">Hi,
<div><br>
</div>
<div>I found python projects to be very good from an code
review perspective.</div>
<div>What I found is Python Language makes it simple to
without an IDE simpler</div>
<div>code to review. I find Java Projects to be the most
difficult to do code review.</div>
<div><br>
</div>
<div>What is the general view on this? Or is it one of my
hallucinations?</div>
<div><br>
</div>
<div>Regards,</div>
<div>Sujit K M</div>
</div>
<br>
_______________________________________________<br>
talk mailing list<br>
<a href="mailto:talk@lists.nycbug.org" target="_blank">talk@lists.nycbug.org</a><br>
<a href="http://lists.nycbug.org/mailman/listinfo/talk" rel="noreferrer" target="_blank">http://lists.nycbug.org/mailman/listinfo/talk</a><br>
</blockquote>
</div>
<br>
</div>
<br>
<fieldset></fieldset>
<br>
<pre>_______________________________________________
talk mailing list
<a href="mailto:talk@lists.nycbug.org" target="_blank">talk@lists.nycbug.org</a>
<a href="http://lists.nycbug.org/mailman/listinfo/talk" target="_blank">http://lists.nycbug.org/mailman/listinfo/talk</a></pre>
</blockquote>
<br>
</div></div></div>
<br>_______________________________________________<br>
talk mailing list<br>
<a href="mailto:talk@lists.nycbug.org" target="_blank">talk@lists.nycbug.org</a><br>
<a href="http://lists.nycbug.org/mailman/listinfo/talk" rel="noreferrer" target="_blank">http://lists.nycbug.org/mailman/listinfo/talk</a><br></blockquote></div><br></div></div>
<br>_______________________________________________<br>
talk mailing list<br>
<a href="mailto:talk@lists.nycbug.org">talk@lists.nycbug.org</a><br>
<a href="http://lists.nycbug.org/mailman/listinfo/talk" rel="noreferrer" target="_blank">http://lists.nycbug.org/mailman/listinfo/talk</a><br></blockquote></div><br></div>