Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I want to document a Java project I'm working on. In the past I've typically documented the design and software API in a wiki. However, after recently using Mockito for mocking tests, I was impressed at the amount and quality of project-level documentation in the actual javadocs.
My question is, do people typically use Javadocs for documenting the higher level view of the project (e.g. architecture, design decisions etc), or is this kind of information best documented in (say) a wiki?
It depends on who your audience is.
If your audience is going to be primarily using the API, it is generally better to invest in clear concise descriptions (with examples) in your Javadoc. If the audience is likely to never see the API, then it is better to maintain your documentation outside of Javadoc. This is primary a function of how the documentation is navigated; Javadoc navigation facilitates the programming process.
As for whether you wish to put the documentation in a wiki or in a PDF, again it depends on the audience. If the only reason for wiki is to have a web facing HTML representation of the documentation, using something similar to Docbook might provide such documentation with the added benefit of ability to generate PDF representations of the same documentation. If you really have an active community, wiki shines in the ability of allowing near-strangers to modify your documentation.
Determine if the strengths of the products align with your needs, and if they do, then it's the right choice.
Javadoc is great for generating API level documentation. I use a wiki for my high level documentation. I use confluence as my wiki and there are a few plugins you can use for architectural diagrams.
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 3 years ago.
Improve this question
Can someone explain why is React so popular?
My understanding is that it helps with the V part of MVC design pattern for apps and is useful as its JS so can be used for UI perhaps in general.
Why would it be better than SPA (not sure I get what this means exactly, i.e. just using Javascript? - Real technical advantages of React Native over Web)
Also, it was created by Facebook so perhaps there is added benefit/functionality through that (if anyone can provide specifics that would help.
But what are the specific technical advantages/efficiencies about React is so advantageous and helpful to developers?
As an example, say I work for a bank and am designing a bank account app - how would React be useful over an alternative?
So it basically depends upon what type of application you are making . Few benefits that I found with react are:
It is based on the concept of virtual dom (main benefit of it): you can read more abt it from https://reactjs.org/docs/faq-internals.html
Easy to learn as mostly it is javascript, ES6 compared to Angular latest versions
Good community support
However, React alone is of no good use for big applications. So ultimately you have to use some state management tool like redux/ flux with it
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
What are the main advantages of using java cloudant client api instead of directly using the cloudant REST API?
thanks
A lot of effort has been made to ensure that the Cloudant Java library is slick to use, and hiding both some of the rough edges of the API, encoding some best practices and saving you from tedious boiler plating.
It also gives you a lot of extra functionality "for free", for example automatic retrying of requests that generated a "429: Too Many Requests" response in the rate-limited environment on IBM Cloud.
The Java library is of course also officially supported, with a regular release cadence, meaning that you can raise tickets against it, and have an expectation that issues will be fixed. As these libraries are developed in conjunction with the service, you can also expect that new features in the service will be reflected in the client libraries.
Saying all that, it's good to reflect on when to use a library that someone else wrote, and when to "roll your own". All languages and platforms tend to have good support for HTTP, and speaking directly to the API can mean that you know exactly what you have, and you can avoid any bloat, especially if you only need a fraction of what the library provides.
Here's an example I wrote (in Python, but the ideas hold for any language) to show how simple it can be to write a "micro" library yourself to target the API directly:
https://github.com/xpqz/microcdt
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
Each Java developer has his each day sites, I want to ask more experienced Java developers about list of web resources that they will recommend to less experienced Java developers.
stackoverflow.com
http://download.oracle.com/javase/6/docs for javadoc :)
any official document for respective framework (for example:springsource.org for spring )
I like to add official Oracle(Sun) Java tutorial, which I feel must for a beginner in Java
http://download.oracle.com/javase/tutorial/
You might be look at Joshua Bloch's book "Effective Java": http://www.amazon.com/Effective-Java-2nd-Joshua-Bloch/dp/0321356683
This is great book about Java program design.
These are my favorite sites (rss enabled):
http://www.javaspecialists.co.za - Problems in Java
http://javaposse.com - New frameworks, random links to java news.
#Bojan Milenkoski is right.
You cant find solution to all problems in single place. One site may be good in Collections but poor in Objects and Data types .
It also depends on how depth you need your answer
Read the Javadocs. Become familiar with the structure as all Javadoc API specs will follow this pattern.
I use Google in general to find solutions to problems. I don't rely on any one given site. Generally, a Google search with the right keywords will yield the best results when searching for the solution to a problem.
It also depends on the context of what you're searching for. If you have a Spring problem, go to http://forum.springsource.org/. If you have a Google App Engine problem, search Google Groups. This rule isn't always true for every tool in your toolbox because sometimes the information is just plain better and more organized in other sources.
Some problems are also very specific and may not be covered specifically in the documentation. It really just depends on the problem.
But in summary, I suggest getting really good at learning to use Google to find information quickly while also weeding out anything that's not relevant to you.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
After google around, I have to ask this question on StackOverflow.
There are frameworks around, but most of them are from 2008 2009, unmaintained, multipage or will not work with GWT 2.0
What are the recommended framework should I use for a single page application that will scale most in term of deploy? 1 language is a plus point because GWT is all about 1 language, beside if we tune the server to run Java and serve HTML pages, it will be faster.
But any framework that works and good is okay also.
Thanks :)
In addition to Jay Askren's suggestions, another good framework is gwt-platform, which is a combination of two other good frameworks, gwt-presenter and gwt-dispatch.
I recommend watching this from last year's Google IO. They recommended using the Model-View-Presenter pattern for GWT apps. Here is one implementation of this pattern.
The following from this year's GoogleIO might also be helpful:
http://code.google.com/events/io/2010/sessions/architecting-performance-gwt.html
http://code.google.com/events/io/2010/sessions/architecting-production-gwt.html
I should also mention that GWT is a framework in and of itself. The above are more best practices on how to use the framework.
Have you looked at Sencha GXT? It's a single page framework.
http://www.sencha.com/products/gxt/
I think it's also important to note that GWT 2.1 will include a lot of application framework pieces. From what I've seen so far on the contributor mailing list, it should include:
MVP framework
EventBus integration
PlaceManager for navigation
Data presentation widgets (i.e. data binding)
Validation hooks? (JSR-303 annotations recently committed)
So make sure to check out vanilla GWT 2.1 M2 as well.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
Which is your top 3 open-source APIs (in Java) you recommend as an example of well-designed piece of art?
That would be code that you had pleasure to browse through and got some insights from it.
Any problem domain acceptable.
Emphasis here is on educational/study quality of code, complexity level - intermediate to top.
Thanks a lot for responses.
I think that google collections is a great place to start. Josh Bloch advised the development of a lot of it, and it's a very well done API. While Spring is great, it's a little hard to know where to start. A good introduction to google collections is "coding in the small with google collections" (I can't post the actual link because of stackoverflow spam filter).
1.Spring
2.Hibernate
Spring - it's a very well written and designed framework. It's a hell of a big bit of software but if want an example of how to build in a modular manner you can't go to fair wrong looking at the spring code base
The sources of the java libraries are well documented.
In my experience the most valuable works include the documentation of desgin decisions, if you see a nice API it would be very interessting what could be the alternatives to that. Unfortunatly this is mostly burried mailing-lists of a project.
Not an external library - but the java.util.concurrent package is very nicely written. The code isn't simple, but it's very well thought out and, in my opinion, has been written brilliantly.