2013-04-02 9 views
5

Un'idea mi è appena venuta in mente. C'è qualche metodo per inserire un'immagine nel commento del codice per aiutare a spiegare il nostro codice? Dopo tutto, un'immagine vale più di mille parole.Inserire un'immagine nel commento di codice via Emacs

Da quando utilizzo Emacs, esistono ancora implementazioni per Emacs?

+0

Le persone hanno utilizzato l'arte ASCII dall'inizio della codifica per aiutare a spiegare l'architettura del loro software. Ma la maggior parte degli editor di testo non ha molto supporto per la grafica ... – deed02392

+0

Emacs fornisce strumenti di basso livello per la visualizzazione di grafica in linea, tuttavia, non sono a conoscenza di alcun pacchetto che ti permetta di farlo per i commenti al codice - Sembra un bel progetto per qualcuno con più tempo libero di quello che ho ... – Lindydancer

+3

Questa è un'idea interessante, ma la logistica è un problema. Le immagini dovrebbero essere abbastanza grandi per essere di qualche utilità, quindi sarebbe una cattiva idea memorizzarle in linea (base64). Se li si archivia al di fuori del file, è necessario ricordare di spostare le immagini insieme al file sorgente. Il problema più grosso è che non è possibile modificare le immagini nell'editor di testo, è necessario utilizzare uno strumento esterno. L'intero punto di un file * source * è che è modificabile, "la forma preferita del lavoro per apportare modifiche ad esso". Le immagini diverse dall'arte ASCII non si adattano al concetto. – user4815162342

risposta

6

Dai uno sguardo allo iimage-mode: è una soluzione standard per visualizzare un'immagine in un buffer di testo.

Ad esempio, dato il seguente file:

/* an image is worth a thousand words: 
* <path/to/image.png> 
*/ 
int main (int argc, char **argv) { 
    return 0; 
} 

quindi eseguendo M-xturn-on-iimage-mode dovrebbe visualizzare image.png in luogo del suo percorso.


Tuttavia, sono d'accordo con @ di user4815162342 commento che è necessario distribuire le immagini insieme con i file di origine e per ricordare loro aggiornamento quando necessario (a volte è difficile per aggiornare commenti del codice, quando sono solo il testo, ma sarà IMO essere più difficile aggiornare i commenti dell'immagine)

+0

+1 Credo che questo sia esattamente ciò che l'OP sta cercando. (Si calcola solo che qualcuno [l'ha già scritto.] (Http://xkcd.com/378/)) – user4815162342

+0

Non posso credere di aver dimenticato "iimage-mode". Molto grato – Wilbeibi

2

Stai parlando di grafica ASCII o di immagini reali?

Per l'arte ASCII, c'è lo M-x artist-mode che consente di disegnare immagini semplici (o non molto semplici). Inoltre, se è necessario disegnare diagrammi UML basati su ASCII, lo CEDET può farlo per te.

Per inserire immagini reali, ci sono un sacco di funzioni come create-image e insert-image, quindi la scrittura di una modalità secondaria per l'inserimento di immagini nei commenti dovrebbe essere semplice. Non sono a conoscenza di soluzioni pronte, però.

+0

Credo che stia preparando una soluzione già pronta per le immagini reali, ma vedere il mio commento per una discussione sui problemi relativi a tale idea. – user4815162342

+0

Grazie per la risposta. Sì, sto cercando una soluzione pronta – Wilbeibi

0

Se si desidera incollare anche le immagini online, cacoo.el sarà molto utile. Memorizza nella cache le immagini online e le ridimensiona con saggezza. Quindi, mostrare l'immagine dalla seconda volta è molto veloce. Funziona anche con le immagini locali.

E 'stato sviluppato per il servizio web chiamato cacco, ma funziona per qualsiasi immagine online.