Collegamento nei commenti di codice (ad altri ancoraggi / commenti unici)

2

Come consiglieresti di creare "ancore" nei commenti di codice, in modo che durante la manutenzione, gli sviluppatori possano facilmente fare riferimenti incrociati ad altri commenti di codice.

Mi rendo conto che il software dovrebbe essere strutturato in modo intelligente e questo dovrebbe mitigare questo requisito in una certa misura, ma mi sono spesso trovato a scrivere un commento in cui vorrei che gli sviluppatori futuri prendessero in considerazione qualcos'altro (non necessariamente una dipendenza diretta).

Ad esempio, "Se cambi questo meccanismo, assicurati di revisionare XYZ". Sto pensando a collegamenti ipertestuali, stile wiki, in cui ogni link ha un identificatore univoco e può avere una relazione uno-a-molti con altri link.

Idealmente, se qualcuno riscrisse parte del mio codice, vorrei che venissero avvisati automaticamente che "qualcos'altro link qui, e dovresti verificarlo nel caso lo stia cambiando" - e io non significa spezzare qualcosa come in "qualcosa non verrà compilato", ma in realtà solo un puntatore (o puntatori) facile da seguire in qualche altra parte di una base di codice che qualcuno (o anche il tuo passato) sentiva che c'era un comprensibile umano collegamento concettuale, concetto o implementazione.

Sarei sorpreso se non ci fosse già uno standard per questo, ma la ricerca di "commenti", "link", "ancora" produce comprensibilmente un proverbiale pagliaio.

    
posta Duncan Awerbuck 15.05.2012 - 12:23
fonte

4 risposte

0

Non esiste un modo indipendente dal punto di vista linguistico per affrontare questo problema: la soluzione è molto legata al tuo metodo di consumo di queste informazioni e a ciò che la tua lingua e i tuoi strumenti possono supportare in modo nativo.

Se la tua lingua e IDE hanno un modo per creare e linkare elementi di codice (come C # XML Doc Comments o Java Doc), puoi associare la documentazione con un elemento di codice pertinente e quindi collegarti a quell'elemento dalle altre posizioni che sono legati a questo. Questo potrebbe essere abbastanza buono come base per una conoscenza da consumare attraverso il tuo IDE. Probabilmente puoi estrarre questa meta-informazione e creare una documentazione di riferimento che potrebbe essere più facile da consumare.

Se il tuo IDE non supporta questo tipo di collegamento, o non vuoi utilizzare queste informazioni attraverso il tuo IDE, devi andare a qualcosa di esterno, a quel punto un Wiki è la soluzione facile. Un collegamento ipertestuale a un articolo può essere rappresentato in qualsiasi file sorgente e tutto ciò che inizia http: // è facilmente seguito da qualsiasi sviluppatore.

    
risposta data 15.05.2012 - 21:18
fonte
2

Se stai lavorando in Java, puoi creare collegamenti ipertestuali in Javadoc, anche se non conosco alcun IDE che sfrutti questo a differenza dell'analisi del codice per determinare quali classi sono collegate tra loro. Vedi la documentazione } per i dettagli, e < a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#inlinelinks"> questo consiglio per quando non per usarli .

    
risposta data 15.05.2012 - 16:48
fonte
1

C # implementa già Commenti della documentazione XML - alcuni degli elementi consentono di fare riferimento ad altri tipi e in base a come produci la documentazione saranno link.

    
risposta data 15.05.2012 - 17:53
fonte
0

Visual Studio 2008, ma non il 2010, aveva un buon addin chiamato HyperAddin per questo scopo. Fondamentalmente dovresti scrivere #anchor in un commento, e altrove usare il codice: #anchor per creare un collegamento a quel commento. Ha anche supportato il ritorno automatico delle parole nei commenti e altre piccole funzioni.

    
risposta data 15.05.2012 - 20:25
fonte