Domande con tag 'javadocs'

domande con tag
2
risposte

I collegamenti ripetuti alla stessa classe in un singolo commento di javadoc sono una cattiva pratica?

Attualmente sto scrivendo un'API e la sua documentazione. Ad esempio, ho qualcosa di simile a questo: public interface Event { } public interface Process { } public interface EventProcessor { /** * Starts to process the sepcified ev...
posta 24.05.2013 - 16:00
1
risposta

Javadoc per un metodo "sovraccarico" statico

Il mio problema è il seguente: Ho un'interfaccia che richiede le sue implementazioni per implementare un metodo statico, ovvero void load() . Tuttavia, fino a Java 8, sembra che non otterremo metodi statici nelle interfacce. Sono certo ch...
posta 18.06.2013 - 17:10
1
risposta

In Java, perché non esiste un metodo di istanza come bigDecimal.isGreaterThan (otherBigDecimal)?

Il modo attuale di sapere se un BigDecimal è maggiore di un altro è bigDecimal.compareTo(otherBigDecimal) > 0 (o one.compareTo(another) == 1 ), ma lo trovo troppo goffo e inespressivo. bigDecimal.isGreaterThan(otherBigDecimal)...
posta 08.06.2016 - 05:25
1
risposta

Un migliore JavaDoc? [chiuso]

Il modello standard JavaDoc (Doclet) non è cambiato molto fino al recente JDK7. A mio parere, il modello JDK7 ha reso ancora più difficile la navigazione. Ho esaminato diversi doclet di terze parti, ma nessuno è quello che voglio. Così ho inizia...
posta 24.10.2012 - 14:59
3
risposte

Metodo preferibile per registrare la documentazione

Come ogni ingegnere del software insegnato sa quanto sia importante la documentazione per i buoni progetti software. Potresti mostrarmi le migliori pratiche per assicurare una buona documentazione a fianco dei commenti di JavaDoc? A mio parer...
posta 24.04.2013 - 22:56
2
risposte

@Deprecated dalla versione x.y in JavaDoc

Questa domanda & le sue risposte sono utili ma non sufficienti per il mio problema. La mia domanda è se voglio aggiungere un javadoc come @Deprecated A partire dalla versione x.y, sostituito da {@link SomeClass} nel javadoc del mio fi...
posta 07.02.2013 - 05:56
1
risposta

I documenti di metodo differiscono tra documenti Java e documenti Android

Alcune volte vedo differenze problematiche tra doc Java e doc in documenti metodo.Per esempio in circa setReadable (boolean readable, boolean ownerOnly) metodo puoi vedere java doc dice che: Throws: SecurityException - If a security...
posta 02.06.2015 - 09:44
4
risposte

Quando si copia / incolla metodi privati è necessario portare con sé il Javadoc? [chiuso]

Quindi, sfortunatamente, sono bloccato con il codice in cui sto facendo questo: @Override method A{ //calls private methods 1-8 } private method 1{ //copy/pasted } E così via per tutti i metodi privati. Avrei preferito che gli svil...
posta 31.07.2014 - 15:05
1
risposta

Formato di documentazione del codice standardizzato, dov'è? [chiuso]

Attualmente sto esaminando gli strumenti di generazione di documentazione API e ho notato che apparentemente non ci sono sforzi in corso nella standardizzazione. Lo stile Javadoc è una specie di convenzione onnipresente ... è usato per Java...
posta 08.05.2012 - 03:51
1
risposta

Prevalenza industriale della specifica JML

Nel corso Java che sto svolgendo attualmente all'università, si dà molta importanza all'utilizzo di costrutti JML come @require e @ensure clausole nei commenti Javadoc. Comprendo che questo sta implementando il progetto per paradigma...
posta 18.05.2017 - 22:59